fidl_fuchsia_examples/
fidl_fuchsia_examples.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_examples_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 = "fuchsia.examples.Echo";
24}
25impl fidl::endpoints::DiscoverableProtocolMarker for EchoMarker {}
26
27pub trait EchoProxyInterface: Send + Sync {
28    type EchoStringResponseFut: std::future::Future<Output = Result<String, fidl::Error>> + Send;
29    fn r#echo_string(&self, value: &str) -> Self::EchoStringResponseFut;
30}
31#[derive(Debug)]
32#[cfg(target_os = "fuchsia")]
33pub struct EchoSynchronousProxy {
34    client: fidl::client::sync::Client,
35}
36
37#[cfg(target_os = "fuchsia")]
38impl fidl::endpoints::SynchronousProxy for EchoSynchronousProxy {
39    type Proxy = EchoProxy;
40    type Protocol = EchoMarker;
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 EchoSynchronousProxy {
57    pub fn new(channel: fidl::Channel) -> Self {
58        let protocol_name = <EchoMarker 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<EchoEvent, fidl::Error> {
69        EchoEvent::decode(self.client.wait_for_event(deadline)?)
70    }
71
72    pub fn r#echo_string(
73        &self,
74        mut value: &str,
75        ___deadline: zx::MonotonicInstant,
76    ) -> Result<String, fidl::Error> {
77        let _response = self.client.send_query::<EchoEchoStringRequest, EchoEchoStringResponse>(
78            (value,),
79            0x75b8274e52d9a616,
80            fidl::encoding::DynamicFlags::empty(),
81            ___deadline,
82        )?;
83        Ok(_response.response)
84    }
85}
86
87#[cfg(target_os = "fuchsia")]
88impl From<EchoSynchronousProxy> for zx::Handle {
89    fn from(value: EchoSynchronousProxy) -> Self {
90        value.into_channel().into()
91    }
92}
93
94#[cfg(target_os = "fuchsia")]
95impl From<fidl::Channel> for EchoSynchronousProxy {
96    fn from(value: fidl::Channel) -> Self {
97        Self::new(value)
98    }
99}
100
101#[derive(Debug, Clone)]
102pub struct EchoProxy {
103    client: fidl::client::Client<fidl::encoding::DefaultFuchsiaResourceDialect>,
104}
105
106impl fidl::endpoints::Proxy for EchoProxy {
107    type Protocol = EchoMarker;
108
109    fn from_channel(inner: ::fidl::AsyncChannel) -> Self {
110        Self::new(inner)
111    }
112
113    fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
114        self.client.into_channel().map_err(|client| Self { client })
115    }
116
117    fn as_channel(&self) -> &::fidl::AsyncChannel {
118        self.client.as_channel()
119    }
120}
121
122impl EchoProxy {
123    /// Create a new Proxy for fuchsia.examples/Echo.
124    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
125        let protocol_name = <EchoMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
126        Self { client: fidl::client::Client::new(channel, protocol_name) }
127    }
128
129    /// Get a Stream of events from the remote end of the protocol.
130    ///
131    /// # Panics
132    ///
133    /// Panics if the event stream was already taken.
134    pub fn take_event_stream(&self) -> EchoEventStream {
135        EchoEventStream { event_receiver: self.client.take_event_receiver() }
136    }
137
138    pub fn r#echo_string(
139        &self,
140        mut value: &str,
141    ) -> fidl::client::QueryResponseFut<String, fidl::encoding::DefaultFuchsiaResourceDialect> {
142        EchoProxyInterface::r#echo_string(self, value)
143    }
144}
145
146impl EchoProxyInterface for EchoProxy {
147    type EchoStringResponseFut =
148        fidl::client::QueryResponseFut<String, fidl::encoding::DefaultFuchsiaResourceDialect>;
149    fn r#echo_string(&self, mut value: &str) -> Self::EchoStringResponseFut {
150        fn _decode(
151            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
152        ) -> Result<String, fidl::Error> {
153            let _response = fidl::client::decode_transaction_body::<
154                EchoEchoStringResponse,
155                fidl::encoding::DefaultFuchsiaResourceDialect,
156                0x75b8274e52d9a616,
157            >(_buf?)?;
158            Ok(_response.response)
159        }
160        self.client.send_query_and_decode::<EchoEchoStringRequest, String>(
161            (value,),
162            0x75b8274e52d9a616,
163            fidl::encoding::DynamicFlags::empty(),
164            _decode,
165        )
166    }
167}
168
169pub struct EchoEventStream {
170    event_receiver: fidl::client::EventReceiver<fidl::encoding::DefaultFuchsiaResourceDialect>,
171}
172
173impl std::marker::Unpin for EchoEventStream {}
174
175impl futures::stream::FusedStream for EchoEventStream {
176    fn is_terminated(&self) -> bool {
177        self.event_receiver.is_terminated()
178    }
179}
180
181impl futures::Stream for EchoEventStream {
182    type Item = Result<EchoEvent, fidl::Error>;
183
184    fn poll_next(
185        mut self: std::pin::Pin<&mut Self>,
186        cx: &mut std::task::Context<'_>,
187    ) -> std::task::Poll<Option<Self::Item>> {
188        match futures::ready!(futures::stream::StreamExt::poll_next_unpin(
189            &mut self.event_receiver,
190            cx
191        )?) {
192            Some(buf) => std::task::Poll::Ready(Some(EchoEvent::decode(buf))),
193            None => std::task::Poll::Ready(None),
194        }
195    }
196}
197
198#[derive(Debug)]
199pub enum EchoEvent {}
200
201impl EchoEvent {
202    /// Decodes a message buffer as a [`EchoEvent`].
203    fn decode(
204        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
205    ) -> Result<EchoEvent, fidl::Error> {
206        let (bytes, _handles) = buf.split_mut();
207        let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
208        debug_assert_eq!(tx_header.tx_id, 0);
209        match tx_header.ordinal {
210            _ => Err(fidl::Error::UnknownOrdinal {
211                ordinal: tx_header.ordinal,
212                protocol_name: <EchoMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
213            }),
214        }
215    }
216}
217
218/// A Stream of incoming requests for fuchsia.examples/Echo.
219pub struct EchoRequestStream {
220    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
221    is_terminated: bool,
222}
223
224impl std::marker::Unpin for EchoRequestStream {}
225
226impl futures::stream::FusedStream for EchoRequestStream {
227    fn is_terminated(&self) -> bool {
228        self.is_terminated
229    }
230}
231
232impl fidl::endpoints::RequestStream for EchoRequestStream {
233    type Protocol = EchoMarker;
234    type ControlHandle = EchoControlHandle;
235
236    fn from_channel(channel: ::fidl::AsyncChannel) -> Self {
237        Self { inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), is_terminated: false }
238    }
239
240    fn control_handle(&self) -> Self::ControlHandle {
241        EchoControlHandle { inner: self.inner.clone() }
242    }
243
244    fn into_inner(
245        self,
246    ) -> (::std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>, bool)
247    {
248        (self.inner, self.is_terminated)
249    }
250
251    fn from_inner(
252        inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
253        is_terminated: bool,
254    ) -> Self {
255        Self { inner, is_terminated }
256    }
257}
258
259impl futures::Stream for EchoRequestStream {
260    type Item = Result<EchoRequest, fidl::Error>;
261
262    fn poll_next(
263        mut self: std::pin::Pin<&mut Self>,
264        cx: &mut std::task::Context<'_>,
265    ) -> std::task::Poll<Option<Self::Item>> {
266        let this = &mut *self;
267        if this.inner.check_shutdown(cx) {
268            this.is_terminated = true;
269            return std::task::Poll::Ready(None);
270        }
271        if this.is_terminated {
272            panic!("polled EchoRequestStream after completion");
273        }
274        fidl::encoding::with_tls_decode_buf::<_, fidl::encoding::DefaultFuchsiaResourceDialect>(
275            |bytes, handles| {
276                match this.inner.channel().read_etc(cx, bytes, handles) {
277                    std::task::Poll::Ready(Ok(())) => {}
278                    std::task::Poll::Pending => return std::task::Poll::Pending,
279                    std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => {
280                        this.is_terminated = true;
281                        return std::task::Poll::Ready(None);
282                    }
283                    std::task::Poll::Ready(Err(e)) => {
284                        return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(
285                            e.into(),
286                        ))))
287                    }
288                }
289
290                // A message has been received from the channel
291                let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
292
293                std::task::Poll::Ready(Some(match header.ordinal {
294                    0x75b8274e52d9a616 => {
295                        header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
296                        let mut req = fidl::new_empty!(
297                            EchoEchoStringRequest,
298                            fidl::encoding::DefaultFuchsiaResourceDialect
299                        );
300                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<EchoEchoStringRequest>(&header, _body_bytes, handles, &mut req)?;
301                        let control_handle = EchoControlHandle { inner: this.inner.clone() };
302                        Ok(EchoRequest::EchoString {
303                            value: req.value,
304
305                            responder: EchoEchoStringResponder {
306                                control_handle: std::mem::ManuallyDrop::new(control_handle),
307                                tx_id: header.tx_id,
308                            },
309                        })
310                    }
311                    _ => Err(fidl::Error::UnknownOrdinal {
312                        ordinal: header.ordinal,
313                        protocol_name: <EchoMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
314                    }),
315                }))
316            },
317        )
318    }
319}
320
321#[derive(Debug)]
322pub enum EchoRequest {
323    EchoString { value: String, responder: EchoEchoStringResponder },
324}
325
326impl EchoRequest {
327    #[allow(irrefutable_let_patterns)]
328    pub fn into_echo_string(self) -> Option<(String, EchoEchoStringResponder)> {
329        if let EchoRequest::EchoString { value, responder } = self {
330            Some((value, responder))
331        } else {
332            None
333        }
334    }
335
336    /// Name of the method defined in FIDL
337    pub fn method_name(&self) -> &'static str {
338        match *self {
339            EchoRequest::EchoString { .. } => "echo_string",
340        }
341    }
342}
343
344#[derive(Debug, Clone)]
345pub struct EchoControlHandle {
346    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
347}
348
349impl fidl::endpoints::ControlHandle for EchoControlHandle {
350    fn shutdown(&self) {
351        self.inner.shutdown()
352    }
353    fn shutdown_with_epitaph(&self, status: zx_status::Status) {
354        self.inner.shutdown_with_epitaph(status)
355    }
356
357    fn is_closed(&self) -> bool {
358        self.inner.channel().is_closed()
359    }
360    fn on_closed(&self) -> fidl::OnSignalsRef<'_> {
361        self.inner.channel().on_closed()
362    }
363
364    #[cfg(target_os = "fuchsia")]
365    fn signal_peer(
366        &self,
367        clear_mask: zx::Signals,
368        set_mask: zx::Signals,
369    ) -> Result<(), zx_status::Status> {
370        use fidl::Peered;
371        self.inner.channel().signal_peer(clear_mask, set_mask)
372    }
373}
374
375impl EchoControlHandle {}
376
377#[must_use = "FIDL methods require a response to be sent"]
378#[derive(Debug)]
379pub struct EchoEchoStringResponder {
380    control_handle: std::mem::ManuallyDrop<EchoControlHandle>,
381    tx_id: u32,
382}
383
384/// Set the the channel to be shutdown (see [`EchoControlHandle::shutdown`])
385/// if the responder is dropped without sending a response, so that the client
386/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
387impl std::ops::Drop for EchoEchoStringResponder {
388    fn drop(&mut self) {
389        self.control_handle.shutdown();
390        // Safety: drops once, never accessed again
391        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
392    }
393}
394
395impl fidl::endpoints::Responder for EchoEchoStringResponder {
396    type ControlHandle = EchoControlHandle;
397
398    fn control_handle(&self) -> &EchoControlHandle {
399        &self.control_handle
400    }
401
402    fn drop_without_shutdown(mut self) {
403        // Safety: drops once, never accessed again due to mem::forget
404        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
405        // Prevent Drop from running (which would shut down the channel)
406        std::mem::forget(self);
407    }
408}
409
410impl EchoEchoStringResponder {
411    /// Sends a response to the FIDL transaction.
412    ///
413    /// Sets the channel to shutdown if an error occurs.
414    pub fn send(self, mut response: &str) -> Result<(), fidl::Error> {
415        let _result = self.send_raw(response);
416        if _result.is_err() {
417            self.control_handle.shutdown();
418        }
419        self.drop_without_shutdown();
420        _result
421    }
422
423    /// Similar to "send" but does not shutdown the channel if an error occurs.
424    pub fn send_no_shutdown_on_err(self, mut response: &str) -> Result<(), fidl::Error> {
425        let _result = self.send_raw(response);
426        self.drop_without_shutdown();
427        _result
428    }
429
430    fn send_raw(&self, mut response: &str) -> Result<(), fidl::Error> {
431        self.control_handle.inner.send::<EchoEchoStringResponse>(
432            (response,),
433            self.tx_id,
434            0x75b8274e52d9a616,
435            fidl::encoding::DynamicFlags::empty(),
436        )
437    }
438}
439
440#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
441pub struct EchoServiceMarker;
442
443#[cfg(target_os = "fuchsia")]
444impl fidl::endpoints::ServiceMarker for EchoServiceMarker {
445    type Proxy = EchoServiceProxy;
446    type Request = EchoServiceRequest;
447    const SERVICE_NAME: &'static str = "fuchsia.examples.EchoService";
448}
449
450/// A request for one of the member protocols of EchoService.
451///
452#[cfg(target_os = "fuchsia")]
453pub enum EchoServiceRequest {
454    RegularEcho(EchoRequestStream),
455    ReversedEcho(EchoRequestStream),
456}
457
458#[cfg(target_os = "fuchsia")]
459impl fidl::endpoints::ServiceRequest for EchoServiceRequest {
460    type Service = EchoServiceMarker;
461
462    fn dispatch(name: &str, _channel: fidl::AsyncChannel) -> Self {
463        match name {
464            "regular_echo" => Self::RegularEcho(
465                <EchoRequestStream as fidl::endpoints::RequestStream>::from_channel(_channel),
466            ),
467            "reversed_echo" => Self::ReversedEcho(
468                <EchoRequestStream as fidl::endpoints::RequestStream>::from_channel(_channel),
469            ),
470            _ => panic!("no such member protocol name for service EchoService"),
471        }
472    }
473
474    fn member_names() -> &'static [&'static str] {
475        &["regular_echo", "reversed_echo"]
476    }
477}
478#[cfg(target_os = "fuchsia")]
479pub struct EchoServiceProxy(#[allow(dead_code)] Box<dyn fidl::endpoints::MemberOpener>);
480
481#[cfg(target_os = "fuchsia")]
482impl fidl::endpoints::ServiceProxy for EchoServiceProxy {
483    type Service = EchoServiceMarker;
484
485    fn from_member_opener(opener: Box<dyn fidl::endpoints::MemberOpener>) -> Self {
486        Self(opener)
487    }
488}
489
490#[cfg(target_os = "fuchsia")]
491impl EchoServiceProxy {
492    pub fn connect_to_regular_echo(&self) -> Result<EchoProxy, fidl::Error> {
493        let (proxy, server_end) = fidl::endpoints::create_proxy::<EchoMarker>();
494        self.connect_channel_to_regular_echo(server_end)?;
495        Ok(proxy)
496    }
497
498    /// Like `connect_to_regular_echo`, but returns a sync proxy.
499    /// See [`Self::connect_to_regular_echo`] for more details.
500    pub fn connect_to_regular_echo_sync(&self) -> Result<EchoSynchronousProxy, fidl::Error> {
501        let (proxy, server_end) = fidl::endpoints::create_sync_proxy::<EchoMarker>();
502        self.connect_channel_to_regular_echo(server_end)?;
503        Ok(proxy)
504    }
505
506    /// Like `connect_to_regular_echo`, but accepts a server end.
507    /// See [`Self::connect_to_regular_echo`] for more details.
508    pub fn connect_channel_to_regular_echo(
509        &self,
510        server_end: fidl::endpoints::ServerEnd<EchoMarker>,
511    ) -> Result<(), fidl::Error> {
512        self.0.open_member("regular_echo", server_end.into_channel())
513    }
514    pub fn connect_to_reversed_echo(&self) -> Result<EchoProxy, fidl::Error> {
515        let (proxy, server_end) = fidl::endpoints::create_proxy::<EchoMarker>();
516        self.connect_channel_to_reversed_echo(server_end)?;
517        Ok(proxy)
518    }
519
520    /// Like `connect_to_reversed_echo`, but returns a sync proxy.
521    /// See [`Self::connect_to_reversed_echo`] for more details.
522    pub fn connect_to_reversed_echo_sync(&self) -> Result<EchoSynchronousProxy, fidl::Error> {
523        let (proxy, server_end) = fidl::endpoints::create_sync_proxy::<EchoMarker>();
524        self.connect_channel_to_reversed_echo(server_end)?;
525        Ok(proxy)
526    }
527
528    /// Like `connect_to_reversed_echo`, but accepts a server end.
529    /// See [`Self::connect_to_reversed_echo`] for more details.
530    pub fn connect_channel_to_reversed_echo(
531        &self,
532        server_end: fidl::endpoints::ServerEnd<EchoMarker>,
533    ) -> Result<(), fidl::Error> {
534        self.0.open_member("reversed_echo", server_end.into_channel())
535    }
536
537    pub fn instance_name(&self) -> &str {
538        self.0.instance_name()
539    }
540}
541
542mod internal {
543    use super::*;
544}
fidl_fuchsia_examples/fidl_fuchsia_examples.rs

fidl_fuchsia_examples/
fidl_fuchsia_examples.rs
