fidl_fuchsia_lowpan/
fidl_fuchsia_lowpan.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_lowpan_common::*;
11use futures::future::{self, MaybeDone, TryFutureExt};
12use zx_status;
13
14#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
15pub struct DeviceWatcherMarker;
16
17impl fidl::endpoints::ProtocolMarker for DeviceWatcherMarker {
18    type Proxy = DeviceWatcherProxy;
19    type RequestStream = DeviceWatcherRequestStream;
20    #[cfg(target_os = "fuchsia")]
21    type SynchronousProxy = DeviceWatcherSynchronousProxy;
22
23    const DEBUG_NAME: &'static str = "fuchsia.lowpan.DeviceWatcher";
24}
25impl fidl::endpoints::DiscoverableProtocolMarker for DeviceWatcherMarker {}
26
27pub trait DeviceWatcherProxyInterface: Send + Sync {
28    type WatchDevicesResponseFut: std::future::Future<Output = Result<(Vec<String>, Vec<String>), fidl::Error>>
29        + Send;
30    fn r#watch_devices(&self) -> Self::WatchDevicesResponseFut;
31}
32#[derive(Debug)]
33#[cfg(target_os = "fuchsia")]
34pub struct DeviceWatcherSynchronousProxy {
35    client: fidl::client::sync::Client,
36}
37
38#[cfg(target_os = "fuchsia")]
39impl fidl::endpoints::SynchronousProxy for DeviceWatcherSynchronousProxy {
40    type Proxy = DeviceWatcherProxy;
41    type Protocol = DeviceWatcherMarker;
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 DeviceWatcherSynchronousProxy {
58    pub fn new(channel: fidl::Channel) -> Self {
59        let protocol_name = <DeviceWatcherMarker 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(
70        &self,
71        deadline: zx::MonotonicInstant,
72    ) -> Result<DeviceWatcherEvent, fidl::Error> {
73        DeviceWatcherEvent::decode(self.client.wait_for_event(deadline)?)
74    }
75
76    /// Observes when devices are added or removed.
77    ///
78    /// The first call to this method returns immediately with a
79    /// `DeviceChanges` struct containing only items in the `added` field with
80    /// the names of all of the current devices. Subsequent calls
81    /// will block until a device has been added or removed, at which
82    /// point it will return with the `added` and/or `removed` fields
83    /// filled out accordingly. The changes are reported since the
84    /// time that the method returned.
85    ///
86    /// If both the `added` and `removed` fields have names in the returned
87    /// table, then the `removed` field MUST be processed BEFORE `added` field.
88    ///
89    /// If a device was added and then removed in-between calls to this
90    /// method, the device will be absent from both the `added` and `removed`
91    /// lists.
92    ///
93    /// If the same device name is listed on both the `added` and `removed`
94    /// fields, then the client should assume that the original device was
95    /// removed and a new device instance started in its place. However, while
96    /// the client should be able to handle this condition, it should not depend
97    /// on the server will always have this behavior.
98    pub fn r#watch_devices(
99        &self,
100        ___deadline: zx::MonotonicInstant,
101    ) -> Result<(Vec<String>, Vec<String>), fidl::Error> {
102        let _response = self
103            .client
104            .send_query::<fidl::encoding::EmptyPayload, DeviceWatcherWatchDevicesResponse>(
105                (),
106                0x61e58136ee1f49b8,
107                fidl::encoding::DynamicFlags::empty(),
108                ___deadline,
109            )?;
110        Ok((_response.added, _response.removed))
111    }
112}
113
114#[cfg(target_os = "fuchsia")]
115impl From<DeviceWatcherSynchronousProxy> for zx::Handle {
116    fn from(value: DeviceWatcherSynchronousProxy) -> Self {
117        value.into_channel().into()
118    }
119}
120
121#[cfg(target_os = "fuchsia")]
122impl From<fidl::Channel> for DeviceWatcherSynchronousProxy {
123    fn from(value: fidl::Channel) -> Self {
124        Self::new(value)
125    }
126}
127
128#[derive(Debug, Clone)]
129pub struct DeviceWatcherProxy {
130    client: fidl::client::Client<fidl::encoding::DefaultFuchsiaResourceDialect>,
131}
132
133impl fidl::endpoints::Proxy for DeviceWatcherProxy {
134    type Protocol = DeviceWatcherMarker;
135
136    fn from_channel(inner: ::fidl::AsyncChannel) -> Self {
137        Self::new(inner)
138    }
139
140    fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
141        self.client.into_channel().map_err(|client| Self { client })
142    }
143
144    fn as_channel(&self) -> &::fidl::AsyncChannel {
145        self.client.as_channel()
146    }
147}
148
149impl DeviceWatcherProxy {
150    /// Create a new Proxy for fuchsia.lowpan/DeviceWatcher.
151    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
152        let protocol_name = <DeviceWatcherMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
153        Self { client: fidl::client::Client::new(channel, protocol_name) }
154    }
155
156    /// Get a Stream of events from the remote end of the protocol.
157    ///
158    /// # Panics
159    ///
160    /// Panics if the event stream was already taken.
161    pub fn take_event_stream(&self) -> DeviceWatcherEventStream {
162        DeviceWatcherEventStream { event_receiver: self.client.take_event_receiver() }
163    }
164
165    /// Observes when devices are added or removed.
166    ///
167    /// The first call to this method returns immediately with a
168    /// `DeviceChanges` struct containing only items in the `added` field with
169    /// the names of all of the current devices. Subsequent calls
170    /// will block until a device has been added or removed, at which
171    /// point it will return with the `added` and/or `removed` fields
172    /// filled out accordingly. The changes are reported since the
173    /// time that the method returned.
174    ///
175    /// If both the `added` and `removed` fields have names in the returned
176    /// table, then the `removed` field MUST be processed BEFORE `added` field.
177    ///
178    /// If a device was added and then removed in-between calls to this
179    /// method, the device will be absent from both the `added` and `removed`
180    /// lists.
181    ///
182    /// If the same device name is listed on both the `added` and `removed`
183    /// fields, then the client should assume that the original device was
184    /// removed and a new device instance started in its place. However, while
185    /// the client should be able to handle this condition, it should not depend
186    /// on the server will always have this behavior.
187    pub fn r#watch_devices(
188        &self,
189    ) -> fidl::client::QueryResponseFut<
190        (Vec<String>, Vec<String>),
191        fidl::encoding::DefaultFuchsiaResourceDialect,
192    > {
193        DeviceWatcherProxyInterface::r#watch_devices(self)
194    }
195}
196
197impl DeviceWatcherProxyInterface for DeviceWatcherProxy {
198    type WatchDevicesResponseFut = fidl::client::QueryResponseFut<
199        (Vec<String>, Vec<String>),
200        fidl::encoding::DefaultFuchsiaResourceDialect,
201    >;
202    fn r#watch_devices(&self) -> Self::WatchDevicesResponseFut {
203        fn _decode(
204            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
205        ) -> Result<(Vec<String>, Vec<String>), fidl::Error> {
206            let _response = fidl::client::decode_transaction_body::<
207                DeviceWatcherWatchDevicesResponse,
208                fidl::encoding::DefaultFuchsiaResourceDialect,
209                0x61e58136ee1f49b8,
210            >(_buf?)?;
211            Ok((_response.added, _response.removed))
212        }
213        self.client
214            .send_query_and_decode::<fidl::encoding::EmptyPayload, (Vec<String>, Vec<String>)>(
215                (),
216                0x61e58136ee1f49b8,
217                fidl::encoding::DynamicFlags::empty(),
218                _decode,
219            )
220    }
221}
222
223pub struct DeviceWatcherEventStream {
224    event_receiver: fidl::client::EventReceiver<fidl::encoding::DefaultFuchsiaResourceDialect>,
225}
226
227impl std::marker::Unpin for DeviceWatcherEventStream {}
228
229impl futures::stream::FusedStream for DeviceWatcherEventStream {
230    fn is_terminated(&self) -> bool {
231        self.event_receiver.is_terminated()
232    }
233}
234
235impl futures::Stream for DeviceWatcherEventStream {
236    type Item = Result<DeviceWatcherEvent, fidl::Error>;
237
238    fn poll_next(
239        mut self: std::pin::Pin<&mut Self>,
240        cx: &mut std::task::Context<'_>,
241    ) -> std::task::Poll<Option<Self::Item>> {
242        match futures::ready!(futures::stream::StreamExt::poll_next_unpin(
243            &mut self.event_receiver,
244            cx
245        )?) {
246            Some(buf) => std::task::Poll::Ready(Some(DeviceWatcherEvent::decode(buf))),
247            None => std::task::Poll::Ready(None),
248        }
249    }
250}
251
252#[derive(Debug)]
253pub enum DeviceWatcherEvent {}
254
255impl DeviceWatcherEvent {
256    /// Decodes a message buffer as a [`DeviceWatcherEvent`].
257    fn decode(
258        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
259    ) -> Result<DeviceWatcherEvent, fidl::Error> {
260        let (bytes, _handles) = buf.split_mut();
261        let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
262        debug_assert_eq!(tx_header.tx_id, 0);
263        match tx_header.ordinal {
264            _ => Err(fidl::Error::UnknownOrdinal {
265                ordinal: tx_header.ordinal,
266                protocol_name: <DeviceWatcherMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
267            }),
268        }
269    }
270}
271
272/// A Stream of incoming requests for fuchsia.lowpan/DeviceWatcher.
273pub struct DeviceWatcherRequestStream {
274    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
275    is_terminated: bool,
276}
277
278impl std::marker::Unpin for DeviceWatcherRequestStream {}
279
280impl futures::stream::FusedStream for DeviceWatcherRequestStream {
281    fn is_terminated(&self) -> bool {
282        self.is_terminated
283    }
284}
285
286impl fidl::endpoints::RequestStream for DeviceWatcherRequestStream {
287    type Protocol = DeviceWatcherMarker;
288    type ControlHandle = DeviceWatcherControlHandle;
289
290    fn from_channel(channel: ::fidl::AsyncChannel) -> Self {
291        Self { inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), is_terminated: false }
292    }
293
294    fn control_handle(&self) -> Self::ControlHandle {
295        DeviceWatcherControlHandle { inner: self.inner.clone() }
296    }
297
298    fn into_inner(
299        self,
300    ) -> (::std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>, bool)
301    {
302        (self.inner, self.is_terminated)
303    }
304
305    fn from_inner(
306        inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
307        is_terminated: bool,
308    ) -> Self {
309        Self { inner, is_terminated }
310    }
311}
312
313impl futures::Stream for DeviceWatcherRequestStream {
314    type Item = Result<DeviceWatcherRequest, fidl::Error>;
315
316    fn poll_next(
317        mut self: std::pin::Pin<&mut Self>,
318        cx: &mut std::task::Context<'_>,
319    ) -> std::task::Poll<Option<Self::Item>> {
320        let this = &mut *self;
321        if this.inner.check_shutdown(cx) {
322            this.is_terminated = true;
323            return std::task::Poll::Ready(None);
324        }
325        if this.is_terminated {
326            panic!("polled DeviceWatcherRequestStream after completion");
327        }
328        fidl::encoding::with_tls_decode_buf::<_, fidl::encoding::DefaultFuchsiaResourceDialect>(
329            |bytes, handles| {
330                match this.inner.channel().read_etc(cx, bytes, handles) {
331                    std::task::Poll::Ready(Ok(())) => {}
332                    std::task::Poll::Pending => return std::task::Poll::Pending,
333                    std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => {
334                        this.is_terminated = true;
335                        return std::task::Poll::Ready(None);
336                    }
337                    std::task::Poll::Ready(Err(e)) => {
338                        return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(
339                            e.into(),
340                        ))))
341                    }
342                }
343
344                // A message has been received from the channel
345                let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
346
347                std::task::Poll::Ready(Some(match header.ordinal {
348                    0x61e58136ee1f49b8 => {
349                        header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
350                        let mut req = fidl::new_empty!(
351                            fidl::encoding::EmptyPayload,
352                            fidl::encoding::DefaultFuchsiaResourceDialect
353                        );
354                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<fidl::encoding::EmptyPayload>(&header, _body_bytes, handles, &mut req)?;
355                        let control_handle =
356                            DeviceWatcherControlHandle { inner: this.inner.clone() };
357                        Ok(DeviceWatcherRequest::WatchDevices {
358                            responder: DeviceWatcherWatchDevicesResponder {
359                                control_handle: std::mem::ManuallyDrop::new(control_handle),
360                                tx_id: header.tx_id,
361                            },
362                        })
363                    }
364                    _ => Err(fidl::Error::UnknownOrdinal {
365                        ordinal: header.ordinal,
366                        protocol_name:
367                            <DeviceWatcherMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
368                    }),
369                }))
370            },
371        )
372    }
373}
374
375/// Protocol for discovering and resolving LoWPAN interfaces and their
376/// associated control protocol instances.
377#[derive(Debug)]
378pub enum DeviceWatcherRequest {
379    /// Observes when devices are added or removed.
380    ///
381    /// The first call to this method returns immediately with a
382    /// `DeviceChanges` struct containing only items in the `added` field with
383    /// the names of all of the current devices. Subsequent calls
384    /// will block until a device has been added or removed, at which
385    /// point it will return with the `added` and/or `removed` fields
386    /// filled out accordingly. The changes are reported since the
387    /// time that the method returned.
388    ///
389    /// If both the `added` and `removed` fields have names in the returned
390    /// table, then the `removed` field MUST be processed BEFORE `added` field.
391    ///
392    /// If a device was added and then removed in-between calls to this
393    /// method, the device will be absent from both the `added` and `removed`
394    /// lists.
395    ///
396    /// If the same device name is listed on both the `added` and `removed`
397    /// fields, then the client should assume that the original device was
398    /// removed and a new device instance started in its place. However, while
399    /// the client should be able to handle this condition, it should not depend
400    /// on the server will always have this behavior.
401    WatchDevices { responder: DeviceWatcherWatchDevicesResponder },
402}
403
404impl DeviceWatcherRequest {
405    #[allow(irrefutable_let_patterns)]
406    pub fn into_watch_devices(self) -> Option<(DeviceWatcherWatchDevicesResponder)> {
407        if let DeviceWatcherRequest::WatchDevices { responder } = self {
408            Some((responder))
409        } else {
410            None
411        }
412    }
413
414    /// Name of the method defined in FIDL
415    pub fn method_name(&self) -> &'static str {
416        match *self {
417            DeviceWatcherRequest::WatchDevices { .. } => "watch_devices",
418        }
419    }
420}
421
422#[derive(Debug, Clone)]
423pub struct DeviceWatcherControlHandle {
424    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
425}
426
427impl fidl::endpoints::ControlHandle for DeviceWatcherControlHandle {
428    fn shutdown(&self) {
429        self.inner.shutdown()
430    }
431    fn shutdown_with_epitaph(&self, status: zx_status::Status) {
432        self.inner.shutdown_with_epitaph(status)
433    }
434
435    fn is_closed(&self) -> bool {
436        self.inner.channel().is_closed()
437    }
438    fn on_closed(&self) -> fidl::OnSignalsRef<'_> {
439        self.inner.channel().on_closed()
440    }
441
442    #[cfg(target_os = "fuchsia")]
443    fn signal_peer(
444        &self,
445        clear_mask: zx::Signals,
446        set_mask: zx::Signals,
447    ) -> Result<(), zx_status::Status> {
448        use fidl::Peered;
449        self.inner.channel().signal_peer(clear_mask, set_mask)
450    }
451}
452
453impl DeviceWatcherControlHandle {}
454
455#[must_use = "FIDL methods require a response to be sent"]
456#[derive(Debug)]
457pub struct DeviceWatcherWatchDevicesResponder {
458    control_handle: std::mem::ManuallyDrop<DeviceWatcherControlHandle>,
459    tx_id: u32,
460}
461
462/// Set the the channel to be shutdown (see [`DeviceWatcherControlHandle::shutdown`])
463/// if the responder is dropped without sending a response, so that the client
464/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
465impl std::ops::Drop for DeviceWatcherWatchDevicesResponder {
466    fn drop(&mut self) {
467        self.control_handle.shutdown();
468        // Safety: drops once, never accessed again
469        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
470    }
471}
472
473impl fidl::endpoints::Responder for DeviceWatcherWatchDevicesResponder {
474    type ControlHandle = DeviceWatcherControlHandle;
475
476    fn control_handle(&self) -> &DeviceWatcherControlHandle {
477        &self.control_handle
478    }
479
480    fn drop_without_shutdown(mut self) {
481        // Safety: drops once, never accessed again due to mem::forget
482        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
483        // Prevent Drop from running (which would shut down the channel)
484        std::mem::forget(self);
485    }
486}
487
488impl DeviceWatcherWatchDevicesResponder {
489    /// Sends a response to the FIDL transaction.
490    ///
491    /// Sets the channel to shutdown if an error occurs.
492    pub fn send(self, mut added: &[String], mut removed: &[String]) -> Result<(), fidl::Error> {
493        let _result = self.send_raw(added, removed);
494        if _result.is_err() {
495            self.control_handle.shutdown();
496        }
497        self.drop_without_shutdown();
498        _result
499    }
500
501    /// Similar to "send" but does not shutdown the channel if an error occurs.
502    pub fn send_no_shutdown_on_err(
503        self,
504        mut added: &[String],
505        mut removed: &[String],
506    ) -> Result<(), fidl::Error> {
507        let _result = self.send_raw(added, removed);
508        self.drop_without_shutdown();
509        _result
510    }
511
512    fn send_raw(&self, mut added: &[String], mut removed: &[String]) -> Result<(), fidl::Error> {
513        self.control_handle.inner.send::<DeviceWatcherWatchDevicesResponse>(
514            (added, removed),
515            self.tx_id,
516            0x61e58136ee1f49b8,
517            fidl::encoding::DynamicFlags::empty(),
518        )
519    }
520}
521
522mod internal {
523    use super::*;
524}
fidl_fuchsia_lowpan/fidl_fuchsia_lowpan.rs

fidl_fuchsia_lowpan/
fidl_fuchsia_lowpan.rs
