fidl_test_checker/
fidl_test_checker.rs

Help
1// WARNING: This file is machine generated by fidlgen.
2
3#![warn(clippy::all)]
4#![allow(unused_parens, unused_mut, unused_imports, nonstandard_style)]
5
6use bitflags::bitflags;
7use fidl::client::QueryResponseFut;
8use fidl::encoding::{MessageBufFor, ProxyChannelBox, ResourceDialect};
9use fidl::endpoints::{ControlHandle as _, Responder as _};
10pub use fidl_test_checker_common::*;
11use futures::future::{self, MaybeDone, TryFutureExt};
12use zx_status;
13
14#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
15pub struct CheckerMarker;
16
17impl fidl::endpoints::ProtocolMarker for CheckerMarker {
18    type Proxy = CheckerProxy;
19    type RequestStream = CheckerRequestStream;
20    #[cfg(target_os = "fuchsia")]
21    type SynchronousProxy = CheckerSynchronousProxy;
22
23    const DEBUG_NAME: &'static str = "test.checker.Checker";
24}
25impl fidl::endpoints::DiscoverableProtocolMarker for CheckerMarker {}
26
27pub trait CheckerProxyInterface: Send + Sync {
28    type SentinelFileContentsResponseFut: std::future::Future<Output = Result<String, fidl::Error>>
29        + Send;
30    fn r#sentinel_file_contents(&self) -> Self::SentinelFileContentsResponseFut;
31}
32#[derive(Debug)]
33#[cfg(target_os = "fuchsia")]
34pub struct CheckerSynchronousProxy {
35    client: fidl::client::sync::Client,
36}
37
38#[cfg(target_os = "fuchsia")]
39impl fidl::endpoints::SynchronousProxy for CheckerSynchronousProxy {
40    type Proxy = CheckerProxy;
41    type Protocol = CheckerMarker;
42
43    fn from_channel(inner: fidl::Channel) -> Self {
44        Self::new(inner)
45    }
46
47    fn into_channel(self) -> fidl::Channel {
48        self.client.into_channel()
49    }
50
51    fn as_channel(&self) -> &fidl::Channel {
52        self.client.as_channel()
53    }
54}
55
56#[cfg(target_os = "fuchsia")]
57impl CheckerSynchronousProxy {
58    pub fn new(channel: fidl::Channel) -> Self {
59        let protocol_name = <CheckerMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
60        Self { client: fidl::client::sync::Client::new(channel, protocol_name) }
61    }
62
63    pub fn into_channel(self) -> fidl::Channel {
64        self.client.into_channel()
65    }
66
67    /// Waits until an event arrives and returns it. It is safe for other
68    /// threads to make concurrent requests while waiting for an event.
69    pub fn wait_for_event(
70        &self,
71        deadline: zx::MonotonicInstant,
72    ) -> Result<CheckerEvent, fidl::Error> {
73        CheckerEvent::decode(self.client.wait_for_event(deadline)?)
74    }
75
76    /// Contains the contents of the "data/bootfs_package_resolver_test_sentinel" file of the
77    /// "fuchsia-boot://root_component_pkg" package if it correctly resolves, otherwise the
78    /// connection will be closed.
79    pub fn r#sentinel_file_contents(
80        &self,
81        ___deadline: zx::MonotonicInstant,
82    ) -> Result<String, fidl::Error> {
83        let _response = self
84            .client
85            .send_query::<fidl::encoding::EmptyPayload, CheckerSentinelFileContentsResponse>(
86                (),
87                0x4733f9bf9988f3d9,
88                fidl::encoding::DynamicFlags::empty(),
89                ___deadline,
90            )?;
91        Ok(_response.contents)
92    }
93}
94
95#[cfg(target_os = "fuchsia")]
96impl From<CheckerSynchronousProxy> for zx::Handle {
97    fn from(value: CheckerSynchronousProxy) -> Self {
98        value.into_channel().into()
99    }
100}
101
102#[cfg(target_os = "fuchsia")]
103impl From<fidl::Channel> for CheckerSynchronousProxy {
104    fn from(value: fidl::Channel) -> Self {
105        Self::new(value)
106    }
107}
108
109#[derive(Debug, Clone)]
110pub struct CheckerProxy {
111    client: fidl::client::Client<fidl::encoding::DefaultFuchsiaResourceDialect>,
112}
113
114impl fidl::endpoints::Proxy for CheckerProxy {
115    type Protocol = CheckerMarker;
116
117    fn from_channel(inner: ::fidl::AsyncChannel) -> Self {
118        Self::new(inner)
119    }
120
121    fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
122        self.client.into_channel().map_err(|client| Self { client })
123    }
124
125    fn as_channel(&self) -> &::fidl::AsyncChannel {
126        self.client.as_channel()
127    }
128}
129
130impl CheckerProxy {
131    /// Create a new Proxy for test.checker/Checker.
132    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
133        let protocol_name = <CheckerMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
134        Self { client: fidl::client::Client::new(channel, protocol_name) }
135    }
136
137    /// Get a Stream of events from the remote end of the protocol.
138    ///
139    /// # Panics
140    ///
141    /// Panics if the event stream was already taken.
142    pub fn take_event_stream(&self) -> CheckerEventStream {
143        CheckerEventStream { event_receiver: self.client.take_event_receiver() }
144    }
145
146    /// Contains the contents of the "data/bootfs_package_resolver_test_sentinel" file of the
147    /// "fuchsia-boot://root_component_pkg" package if it correctly resolves, otherwise the
148    /// connection will be closed.
149    pub fn r#sentinel_file_contents(
150        &self,
151    ) -> fidl::client::QueryResponseFut<String, fidl::encoding::DefaultFuchsiaResourceDialect> {
152        CheckerProxyInterface::r#sentinel_file_contents(self)
153    }
154}
155
156impl CheckerProxyInterface for CheckerProxy {
157    type SentinelFileContentsResponseFut =
158        fidl::client::QueryResponseFut<String, fidl::encoding::DefaultFuchsiaResourceDialect>;
159    fn r#sentinel_file_contents(&self) -> Self::SentinelFileContentsResponseFut {
160        fn _decode(
161            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
162        ) -> Result<String, fidl::Error> {
163            let _response = fidl::client::decode_transaction_body::<
164                CheckerSentinelFileContentsResponse,
165                fidl::encoding::DefaultFuchsiaResourceDialect,
166                0x4733f9bf9988f3d9,
167            >(_buf?)?;
168            Ok(_response.contents)
169        }
170        self.client.send_query_and_decode::<fidl::encoding::EmptyPayload, String>(
171            (),
172            0x4733f9bf9988f3d9,
173            fidl::encoding::DynamicFlags::empty(),
174            _decode,
175        )
176    }
177}
178
179pub struct CheckerEventStream {
180    event_receiver: fidl::client::EventReceiver<fidl::encoding::DefaultFuchsiaResourceDialect>,
181}
182
183impl std::marker::Unpin for CheckerEventStream {}
184
185impl futures::stream::FusedStream for CheckerEventStream {
186    fn is_terminated(&self) -> bool {
187        self.event_receiver.is_terminated()
188    }
189}
190
191impl futures::Stream for CheckerEventStream {
192    type Item = Result<CheckerEvent, fidl::Error>;
193
194    fn poll_next(
195        mut self: std::pin::Pin<&mut Self>,
196        cx: &mut std::task::Context<'_>,
197    ) -> std::task::Poll<Option<Self::Item>> {
198        match futures::ready!(futures::stream::StreamExt::poll_next_unpin(
199            &mut self.event_receiver,
200            cx
201        )?) {
202            Some(buf) => std::task::Poll::Ready(Some(CheckerEvent::decode(buf))),
203            None => std::task::Poll::Ready(None),
204        }
205    }
206}
207
208#[derive(Debug)]
209pub enum CheckerEvent {}
210
211impl CheckerEvent {
212    /// Decodes a message buffer as a [`CheckerEvent`].
213    fn decode(
214        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
215    ) -> Result<CheckerEvent, fidl::Error> {
216        let (bytes, _handles) = buf.split_mut();
217        let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
218        debug_assert_eq!(tx_header.tx_id, 0);
219        match tx_header.ordinal {
220            _ => Err(fidl::Error::UnknownOrdinal {
221                ordinal: tx_header.ordinal,
222                protocol_name: <CheckerMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
223            }),
224        }
225    }
226}
227
228/// A Stream of incoming requests for test.checker/Checker.
229pub struct CheckerRequestStream {
230    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
231    is_terminated: bool,
232}
233
234impl std::marker::Unpin for CheckerRequestStream {}
235
236impl futures::stream::FusedStream for CheckerRequestStream {
237    fn is_terminated(&self) -> bool {
238        self.is_terminated
239    }
240}
241
242impl fidl::endpoints::RequestStream for CheckerRequestStream {
243    type Protocol = CheckerMarker;
244    type ControlHandle = CheckerControlHandle;
245
246    fn from_channel(channel: ::fidl::AsyncChannel) -> Self {
247        Self { inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), is_terminated: false }
248    }
249
250    fn control_handle(&self) -> Self::ControlHandle {
251        CheckerControlHandle { inner: self.inner.clone() }
252    }
253
254    fn into_inner(
255        self,
256    ) -> (::std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>, bool)
257    {
258        (self.inner, self.is_terminated)
259    }
260
261    fn from_inner(
262        inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
263        is_terminated: bool,
264    ) -> Self {
265        Self { inner, is_terminated }
266    }
267}
268
269impl futures::Stream for CheckerRequestStream {
270    type Item = Result<CheckerRequest, fidl::Error>;
271
272    fn poll_next(
273        mut self: std::pin::Pin<&mut Self>,
274        cx: &mut std::task::Context<'_>,
275    ) -> std::task::Poll<Option<Self::Item>> {
276        let this = &mut *self;
277        if this.inner.check_shutdown(cx) {
278            this.is_terminated = true;
279            return std::task::Poll::Ready(None);
280        }
281        if this.is_terminated {
282            panic!("polled CheckerRequestStream after completion");
283        }
284        fidl::encoding::with_tls_decode_buf::<_, fidl::encoding::DefaultFuchsiaResourceDialect>(
285            |bytes, handles| {
286                match this.inner.channel().read_etc(cx, bytes, handles) {
287                    std::task::Poll::Ready(Ok(())) => {}
288                    std::task::Poll::Pending => return std::task::Poll::Pending,
289                    std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => {
290                        this.is_terminated = true;
291                        return std::task::Poll::Ready(None);
292                    }
293                    std::task::Poll::Ready(Err(e)) => {
294                        return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(
295                            e.into(),
296                        ))))
297                    }
298                }
299
300                // A message has been received from the channel
301                let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
302
303                std::task::Poll::Ready(Some(match header.ordinal {
304                    0x4733f9bf9988f3d9 => {
305                        header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
306                        let mut req = fidl::new_empty!(
307                            fidl::encoding::EmptyPayload,
308                            fidl::encoding::DefaultFuchsiaResourceDialect
309                        );
310                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<fidl::encoding::EmptyPayload>(&header, _body_bytes, handles, &mut req)?;
311                        let control_handle = CheckerControlHandle { inner: this.inner.clone() };
312                        Ok(CheckerRequest::SentinelFileContents {
313                            responder: CheckerSentinelFileContentsResponder {
314                                control_handle: std::mem::ManuallyDrop::new(control_handle),
315                                tx_id: header.tx_id,
316                            },
317                        })
318                    }
319                    _ => Err(fidl::Error::UnknownOrdinal {
320                        ordinal: header.ordinal,
321                        protocol_name:
322                            <CheckerMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
323                    }),
324                }))
325            },
326        )
327    }
328}
329
330#[derive(Debug)]
331pub enum CheckerRequest {
332    /// Contains the contents of the "data/bootfs_package_resolver_test_sentinel" file of the
333    /// "fuchsia-boot://root_component_pkg" package if it correctly resolves, otherwise the
334    /// connection will be closed.
335    SentinelFileContents { responder: CheckerSentinelFileContentsResponder },
336}
337
338impl CheckerRequest {
339    #[allow(irrefutable_let_patterns)]
340    pub fn into_sentinel_file_contents(self) -> Option<(CheckerSentinelFileContentsResponder)> {
341        if let CheckerRequest::SentinelFileContents { responder } = self {
342            Some((responder))
343        } else {
344            None
345        }
346    }
347
348    /// Name of the method defined in FIDL
349    pub fn method_name(&self) -> &'static str {
350        match *self {
351            CheckerRequest::SentinelFileContents { .. } => "sentinel_file_contents",
352        }
353    }
354}
355
356#[derive(Debug, Clone)]
357pub struct CheckerControlHandle {
358    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
359}
360
361impl fidl::endpoints::ControlHandle for CheckerControlHandle {
362    fn shutdown(&self) {
363        self.inner.shutdown()
364    }
365    fn shutdown_with_epitaph(&self, status: zx_status::Status) {
366        self.inner.shutdown_with_epitaph(status)
367    }
368
369    fn is_closed(&self) -> bool {
370        self.inner.channel().is_closed()
371    }
372    fn on_closed(&self) -> fidl::OnSignalsRef<'_> {
373        self.inner.channel().on_closed()
374    }
375
376    #[cfg(target_os = "fuchsia")]
377    fn signal_peer(
378        &self,
379        clear_mask: zx::Signals,
380        set_mask: zx::Signals,
381    ) -> Result<(), zx_status::Status> {
382        use fidl::Peered;
383        self.inner.channel().signal_peer(clear_mask, set_mask)
384    }
385}
386
387impl CheckerControlHandle {}
388
389#[must_use = "FIDL methods require a response to be sent"]
390#[derive(Debug)]
391pub struct CheckerSentinelFileContentsResponder {
392    control_handle: std::mem::ManuallyDrop<CheckerControlHandle>,
393    tx_id: u32,
394}
395
396/// Set the the channel to be shutdown (see [`CheckerControlHandle::shutdown`])
397/// if the responder is dropped without sending a response, so that the client
398/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
399impl std::ops::Drop for CheckerSentinelFileContentsResponder {
400    fn drop(&mut self) {
401        self.control_handle.shutdown();
402        // Safety: drops once, never accessed again
403        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
404    }
405}
406
407impl fidl::endpoints::Responder for CheckerSentinelFileContentsResponder {
408    type ControlHandle = CheckerControlHandle;
409
410    fn control_handle(&self) -> &CheckerControlHandle {
411        &self.control_handle
412    }
413
414    fn drop_without_shutdown(mut self) {
415        // Safety: drops once, never accessed again due to mem::forget
416        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
417        // Prevent Drop from running (which would shut down the channel)
418        std::mem::forget(self);
419    }
420}
421
422impl CheckerSentinelFileContentsResponder {
423    /// Sends a response to the FIDL transaction.
424    ///
425    /// Sets the channel to shutdown if an error occurs.
426    pub fn send(self, mut contents: &str) -> Result<(), fidl::Error> {
427        let _result = self.send_raw(contents);
428        if _result.is_err() {
429            self.control_handle.shutdown();
430        }
431        self.drop_without_shutdown();
432        _result
433    }
434
435    /// Similar to "send" but does not shutdown the channel if an error occurs.
436    pub fn send_no_shutdown_on_err(self, mut contents: &str) -> Result<(), fidl::Error> {
437        let _result = self.send_raw(contents);
438        self.drop_without_shutdown();
439        _result
440    }
441
442    fn send_raw(&self, mut contents: &str) -> Result<(), fidl::Error> {
443        self.control_handle.inner.send::<CheckerSentinelFileContentsResponse>(
444            (contents,),
445            self.tx_id,
446            0x4733f9bf9988f3d9,
447            fidl::encoding::DynamicFlags::empty(),
448        )
449    }
450}
451
452mod internal {
453    use super::*;
454}
fidl_test_checker/fidl_test_checker.rs

fidl_test_checker/
fidl_test_checker.rs
