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

fidl_fuchsia_test_suspend/
fidl_fuchsia_test_suspend.rs
