fidl_fuchsia_test_suspend/
fidl_fuchsia_test_suspend.rs

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