fidl_test_echo/
fidl_test_echo.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_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 = "test.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    pub fn r#echo_string(
74        &self,
75        mut value: Option<&str>,
76        ___deadline: zx::MonotonicInstant,
77    ) -> Result<Option<String>, fidl::Error> {
78        let _response = self.client.send_query::<EchoEchoStringRequest, EchoEchoStringResponse>(
79            (value,),
80            0x1e16cc1b194790f6,
81            fidl::encoding::DynamicFlags::empty(),
82            ___deadline,
83        )?;
84        Ok(_response.response)
85    }
86}
87
88#[cfg(target_os = "fuchsia")]
89impl From<EchoSynchronousProxy> for zx::Handle {
90    fn from(value: EchoSynchronousProxy) -> Self {
91        value.into_channel().into()
92    }
93}
94
95#[cfg(target_os = "fuchsia")]
96impl From<fidl::Channel> for EchoSynchronousProxy {
97    fn from(value: fidl::Channel) -> Self {
98        Self::new(value)
99    }
100}
101
102#[derive(Debug, Clone)]
103pub struct EchoProxy {
104    client: fidl::client::Client<fidl::encoding::DefaultFuchsiaResourceDialect>,
105}
106
107impl fidl::endpoints::Proxy for EchoProxy {
108    type Protocol = EchoMarker;
109
110    fn from_channel(inner: ::fidl::AsyncChannel) -> Self {
111        Self::new(inner)
112    }
113
114    fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
115        self.client.into_channel().map_err(|client| Self { client })
116    }
117
118    fn as_channel(&self) -> &::fidl::AsyncChannel {
119        self.client.as_channel()
120    }
121}
122
123impl EchoProxy {
124    /// Create a new Proxy for test.echo/Echo.
125    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
126        let protocol_name = <EchoMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
127        Self { client: fidl::client::Client::new(channel, protocol_name) }
128    }
129
130    /// Get a Stream of events from the remote end of the protocol.
131    ///
132    /// # Panics
133    ///
134    /// Panics if the event stream was already taken.
135    pub fn take_event_stream(&self) -> EchoEventStream {
136        EchoEventStream { event_receiver: self.client.take_event_receiver() }
137    }
138
139    pub fn r#echo_string(
140        &self,
141        mut value: Option<&str>,
142    ) -> fidl::client::QueryResponseFut<Option<String>, fidl::encoding::DefaultFuchsiaResourceDialect>
143    {
144        EchoProxyInterface::r#echo_string(self, value)
145    }
146}
147
148impl EchoProxyInterface for EchoProxy {
149    type EchoStringResponseFut = fidl::client::QueryResponseFut<
150        Option<String>,
151        fidl::encoding::DefaultFuchsiaResourceDialect,
152    >;
153    fn r#echo_string(&self, mut value: Option<&str>) -> Self::EchoStringResponseFut {
154        fn _decode(
155            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
156        ) -> Result<Option<String>, fidl::Error> {
157            let _response = fidl::client::decode_transaction_body::<
158                EchoEchoStringResponse,
159                fidl::encoding::DefaultFuchsiaResourceDialect,
160                0x1e16cc1b194790f6,
161            >(_buf?)?;
162            Ok(_response.response)
163        }
164        self.client.send_query_and_decode::<EchoEchoStringRequest, Option<String>>(
165            (value,),
166            0x1e16cc1b194790f6,
167            fidl::encoding::DynamicFlags::empty(),
168            _decode,
169        )
170    }
171}
172
173pub struct EchoEventStream {
174    event_receiver: fidl::client::EventReceiver<fidl::encoding::DefaultFuchsiaResourceDialect>,
175}
176
177impl std::marker::Unpin for EchoEventStream {}
178
179impl futures::stream::FusedStream for EchoEventStream {
180    fn is_terminated(&self) -> bool {
181        self.event_receiver.is_terminated()
182    }
183}
184
185impl futures::Stream for EchoEventStream {
186    type Item = Result<EchoEvent, 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(EchoEvent::decode(buf))),
197            None => std::task::Poll::Ready(None),
198        }
199    }
200}
201
202#[derive(Debug)]
203pub enum EchoEvent {}
204
205impl EchoEvent {
206    /// Decodes a message buffer as a [`EchoEvent`].
207    fn decode(
208        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
209    ) -> Result<EchoEvent, 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: <EchoMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
217            }),
218        }
219    }
220}
221
222/// A Stream of incoming requests for test.echo/Echo.
223pub struct EchoRequestStream {
224    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
225    is_terminated: bool,
226}
227
228impl std::marker::Unpin for EchoRequestStream {}
229
230impl futures::stream::FusedStream for EchoRequestStream {
231    fn is_terminated(&self) -> bool {
232        self.is_terminated
233    }
234}
235
236impl fidl::endpoints::RequestStream for EchoRequestStream {
237    type Protocol = EchoMarker;
238    type ControlHandle = EchoControlHandle;
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        EchoControlHandle { 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 EchoRequestStream {
264    type Item = Result<EchoRequest, 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 EchoRequestStream 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                    0x1e16cc1b194790f6 => {
299                        header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
300                        let mut req = fidl::new_empty!(
301                            EchoEchoStringRequest,
302                            fidl::encoding::DefaultFuchsiaResourceDialect
303                        );
304                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<EchoEchoStringRequest>(&header, _body_bytes, handles, &mut req)?;
305                        let control_handle = EchoControlHandle { inner: this.inner.clone() };
306                        Ok(EchoRequest::EchoString {
307                            value: req.value,
308
309                            responder: EchoEchoStringResponder {
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: <EchoMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
318                    }),
319                }))
320            },
321        )
322    }
323}
324
325#[derive(Debug)]
326pub enum EchoRequest {
327    EchoString { value: Option<String>, responder: EchoEchoStringResponder },
328}
329
330impl EchoRequest {
331    #[allow(irrefutable_let_patterns)]
332    pub fn into_echo_string(self) -> Option<(Option<String>, EchoEchoStringResponder)> {
333        if let EchoRequest::EchoString { value, responder } = self {
334            Some((value, responder))
335        } else {
336            None
337        }
338    }
339
340    /// Name of the method defined in FIDL
341    pub fn method_name(&self) -> &'static str {
342        match *self {
343            EchoRequest::EchoString { .. } => "echo_string",
344        }
345    }
346}
347
348#[derive(Debug, Clone)]
349pub struct EchoControlHandle {
350    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
351}
352
353impl fidl::endpoints::ControlHandle for EchoControlHandle {
354    fn shutdown(&self) {
355        self.inner.shutdown()
356    }
357    fn shutdown_with_epitaph(&self, status: zx_status::Status) {
358        self.inner.shutdown_with_epitaph(status)
359    }
360
361    fn is_closed(&self) -> bool {
362        self.inner.channel().is_closed()
363    }
364    fn on_closed(&self) -> fidl::OnSignalsRef<'_> {
365        self.inner.channel().on_closed()
366    }
367
368    #[cfg(target_os = "fuchsia")]
369    fn signal_peer(
370        &self,
371        clear_mask: zx::Signals,
372        set_mask: zx::Signals,
373    ) -> Result<(), zx_status::Status> {
374        use fidl::Peered;
375        self.inner.channel().signal_peer(clear_mask, set_mask)
376    }
377}
378
379impl EchoControlHandle {}
380
381#[must_use = "FIDL methods require a response to be sent"]
382#[derive(Debug)]
383pub struct EchoEchoStringResponder {
384    control_handle: std::mem::ManuallyDrop<EchoControlHandle>,
385    tx_id: u32,
386}
387
388/// Set the the channel to be shutdown (see [`EchoControlHandle::shutdown`])
389/// if the responder is dropped without sending a response, so that the client
390/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
391impl std::ops::Drop for EchoEchoStringResponder {
392    fn drop(&mut self) {
393        self.control_handle.shutdown();
394        // Safety: drops once, never accessed again
395        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
396    }
397}
398
399impl fidl::endpoints::Responder for EchoEchoStringResponder {
400    type ControlHandle = EchoControlHandle;
401
402    fn control_handle(&self) -> &EchoControlHandle {
403        &self.control_handle
404    }
405
406    fn drop_without_shutdown(mut self) {
407        // Safety: drops once, never accessed again due to mem::forget
408        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
409        // Prevent Drop from running (which would shut down the channel)
410        std::mem::forget(self);
411    }
412}
413
414impl EchoEchoStringResponder {
415    /// Sends a response to the FIDL transaction.
416    ///
417    /// Sets the channel to shutdown if an error occurs.
418    pub fn send(self, mut response: Option<&str>) -> Result<(), fidl::Error> {
419        let _result = self.send_raw(response);
420        if _result.is_err() {
421            self.control_handle.shutdown();
422        }
423        self.drop_without_shutdown();
424        _result
425    }
426
427    /// Similar to "send" but does not shutdown the channel if an error occurs.
428    pub fn send_no_shutdown_on_err(self, mut response: Option<&str>) -> Result<(), fidl::Error> {
429        let _result = self.send_raw(response);
430        self.drop_without_shutdown();
431        _result
432    }
433
434    fn send_raw(&self, mut response: Option<&str>) -> Result<(), fidl::Error> {
435        self.control_handle.inner.send::<EchoEchoStringResponse>(
436            (response,),
437            self.tx_id,
438            0x1e16cc1b194790f6,
439            fidl::encoding::DynamicFlags::empty(),
440        )
441    }
442}
443
444mod internal {
445    use super::*;
446}
fidl_test_echo/fidl_test_echo.rs

fidl_test_echo/
fidl_test_echo.rs
