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

fidl_fidl_examples_routing_echo/
fidl_fidl_examples_routing_echo.rs
