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

fidl_fuchsia_device_firmware_test/
fidl_fuchsia_device_firmware_test.rs
