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

fidl_test_ping/
fidl_test_ping.rs
