fidl_examples_keyvaluestore_usegenericvalues/
fidl_examples_keyvaluestore_usegenericvalues.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_examples_keyvaluestore_usegenericvalues_common::*;
11use futures::future::{self, MaybeDone, TryFutureExt};
12use zx_status;
13
14#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
15pub struct StoreMarker;
16
17impl fidl::endpoints::ProtocolMarker for StoreMarker {
18    type Proxy = StoreProxy;
19    type RequestStream = StoreRequestStream;
20    #[cfg(target_os = "fuchsia")]
21    type SynchronousProxy = StoreSynchronousProxy;
22
23    const DEBUG_NAME: &'static str = "examples.keyvaluestore.usegenericvalues.Store";
24}
25impl fidl::endpoints::DiscoverableProtocolMarker for StoreMarker {}
26pub type StoreWriteItemResult = Result<Value, WriteError>;
27
28pub trait StoreProxyInterface: Send + Sync {
29    type WriteItemResponseFut: std::future::Future<Output = Result<StoreWriteItemResult, fidl::Error>>
30        + Send;
31    fn r#write_item(&self, payload: &StoreWriteItemRequest) -> Self::WriteItemResponseFut;
32}
33#[derive(Debug)]
34#[cfg(target_os = "fuchsia")]
35pub struct StoreSynchronousProxy {
36    client: fidl::client::sync::Client,
37}
38
39#[cfg(target_os = "fuchsia")]
40impl fidl::endpoints::SynchronousProxy for StoreSynchronousProxy {
41    type Proxy = StoreProxy;
42    type Protocol = StoreMarker;
43
44    fn from_channel(inner: fidl::Channel) -> Self {
45        Self::new(inner)
46    }
47
48    fn into_channel(self) -> fidl::Channel {
49        self.client.into_channel()
50    }
51
52    fn as_channel(&self) -> &fidl::Channel {
53        self.client.as_channel()
54    }
55}
56
57#[cfg(target_os = "fuchsia")]
58impl StoreSynchronousProxy {
59    pub fn new(channel: fidl::Channel) -> Self {
60        let protocol_name = <StoreMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
61        Self { client: fidl::client::sync::Client::new(channel, protocol_name) }
62    }
63
64    pub fn into_channel(self) -> fidl::Channel {
65        self.client.into_channel()
66    }
67
68    /// Waits until an event arrives and returns it. It is safe for other
69    /// threads to make concurrent requests while waiting for an event.
70    pub fn wait_for_event(
71        &self,
72        deadline: zx::MonotonicInstant,
73    ) -> Result<StoreEvent, fidl::Error> {
74        StoreEvent::decode(self.client.wait_for_event(deadline)?)
75    }
76
77    /// Writes an item to the store.
78    ///
79    /// Since the value stored in the key-value store can now be different from the input (if the
80    /// `WriteOptions.CONCAT` flag is set), we need to return the resulting `Value` to the
81    /// requester.
82    ///
83    /// We use an (anonymous) `table` and a (named) `flexible union` as the request and response
84    /// payload, respectively, to allow for easier future evolution. Both of these types are
85    /// `flexible`, meaning that adding or removing members is binary-compatible. This makes them
86    /// much easier to evolve that the `struct` types that were previously used, which cannot be
87    /// changed after release without breaking ABI.
88    pub fn r#write_item(
89        &self,
90        mut payload: &StoreWriteItemRequest,
91        ___deadline: zx::MonotonicInstant,
92    ) -> Result<StoreWriteItemResult, fidl::Error> {
93        let _response = self.client.send_query::<
94            StoreWriteItemRequest,
95            fidl::encoding::FlexibleResultType<Value, WriteError>,
96        >(
97            payload,
98            0xdbd4bf1e49abe6e,
99            fidl::encoding::DynamicFlags::FLEXIBLE,
100            ___deadline,
101        )?
102        .into_result::<StoreMarker>("write_item")?;
103        Ok(_response.map(|x| x))
104    }
105}
106
107#[cfg(target_os = "fuchsia")]
108impl From<StoreSynchronousProxy> for zx::Handle {
109    fn from(value: StoreSynchronousProxy) -> Self {
110        value.into_channel().into()
111    }
112}
113
114#[cfg(target_os = "fuchsia")]
115impl From<fidl::Channel> for StoreSynchronousProxy {
116    fn from(value: fidl::Channel) -> Self {
117        Self::new(value)
118    }
119}
120
121#[derive(Debug, Clone)]
122pub struct StoreProxy {
123    client: fidl::client::Client<fidl::encoding::DefaultFuchsiaResourceDialect>,
124}
125
126impl fidl::endpoints::Proxy for StoreProxy {
127    type Protocol = StoreMarker;
128
129    fn from_channel(inner: ::fidl::AsyncChannel) -> Self {
130        Self::new(inner)
131    }
132
133    fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
134        self.client.into_channel().map_err(|client| Self { client })
135    }
136
137    fn as_channel(&self) -> &::fidl::AsyncChannel {
138        self.client.as_channel()
139    }
140}
141
142impl StoreProxy {
143    /// Create a new Proxy for examples.keyvaluestore.usegenericvalues/Store.
144    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
145        let protocol_name = <StoreMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
146        Self { client: fidl::client::Client::new(channel, protocol_name) }
147    }
148
149    /// Get a Stream of events from the remote end of the protocol.
150    ///
151    /// # Panics
152    ///
153    /// Panics if the event stream was already taken.
154    pub fn take_event_stream(&self) -> StoreEventStream {
155        StoreEventStream { event_receiver: self.client.take_event_receiver() }
156    }
157
158    /// Writes an item to the store.
159    ///
160    /// Since the value stored in the key-value store can now be different from the input (if the
161    /// `WriteOptions.CONCAT` flag is set), we need to return the resulting `Value` to the
162    /// requester.
163    ///
164    /// We use an (anonymous) `table` and a (named) `flexible union` as the request and response
165    /// payload, respectively, to allow for easier future evolution. Both of these types are
166    /// `flexible`, meaning that adding or removing members is binary-compatible. This makes them
167    /// much easier to evolve that the `struct` types that were previously used, which cannot be
168    /// changed after release without breaking ABI.
169    pub fn r#write_item(
170        &self,
171        mut payload: &StoreWriteItemRequest,
172    ) -> fidl::client::QueryResponseFut<
173        StoreWriteItemResult,
174        fidl::encoding::DefaultFuchsiaResourceDialect,
175    > {
176        StoreProxyInterface::r#write_item(self, payload)
177    }
178}
179
180impl StoreProxyInterface for StoreProxy {
181    type WriteItemResponseFut = fidl::client::QueryResponseFut<
182        StoreWriteItemResult,
183        fidl::encoding::DefaultFuchsiaResourceDialect,
184    >;
185    fn r#write_item(&self, mut payload: &StoreWriteItemRequest) -> Self::WriteItemResponseFut {
186        fn _decode(
187            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
188        ) -> Result<StoreWriteItemResult, fidl::Error> {
189            let _response = fidl::client::decode_transaction_body::<
190                fidl::encoding::FlexibleResultType<Value, WriteError>,
191                fidl::encoding::DefaultFuchsiaResourceDialect,
192                0xdbd4bf1e49abe6e,
193            >(_buf?)?
194            .into_result::<StoreMarker>("write_item")?;
195            Ok(_response.map(|x| x))
196        }
197        self.client.send_query_and_decode::<StoreWriteItemRequest, StoreWriteItemResult>(
198            payload,
199            0xdbd4bf1e49abe6e,
200            fidl::encoding::DynamicFlags::FLEXIBLE,
201            _decode,
202        )
203    }
204}
205
206pub struct StoreEventStream {
207    event_receiver: fidl::client::EventReceiver<fidl::encoding::DefaultFuchsiaResourceDialect>,
208}
209
210impl std::marker::Unpin for StoreEventStream {}
211
212impl futures::stream::FusedStream for StoreEventStream {
213    fn is_terminated(&self) -> bool {
214        self.event_receiver.is_terminated()
215    }
216}
217
218impl futures::Stream for StoreEventStream {
219    type Item = Result<StoreEvent, fidl::Error>;
220
221    fn poll_next(
222        mut self: std::pin::Pin<&mut Self>,
223        cx: &mut std::task::Context<'_>,
224    ) -> std::task::Poll<Option<Self::Item>> {
225        match futures::ready!(futures::stream::StreamExt::poll_next_unpin(
226            &mut self.event_receiver,
227            cx
228        )?) {
229            Some(buf) => std::task::Poll::Ready(Some(StoreEvent::decode(buf))),
230            None => std::task::Poll::Ready(None),
231        }
232    }
233}
234
235#[derive(Debug)]
236pub enum StoreEvent {
237    #[non_exhaustive]
238    _UnknownEvent {
239        /// Ordinal of the event that was sent.
240        ordinal: u64,
241    },
242}
243
244impl StoreEvent {
245    /// Decodes a message buffer as a [`StoreEvent`].
246    fn decode(
247        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
248    ) -> Result<StoreEvent, fidl::Error> {
249        let (bytes, _handles) = buf.split_mut();
250        let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
251        debug_assert_eq!(tx_header.tx_id, 0);
252        match tx_header.ordinal {
253            _ if tx_header.dynamic_flags().contains(fidl::encoding::DynamicFlags::FLEXIBLE) => {
254                Ok(StoreEvent::_UnknownEvent { ordinal: tx_header.ordinal })
255            }
256            _ => Err(fidl::Error::UnknownOrdinal {
257                ordinal: tx_header.ordinal,
258                protocol_name: <StoreMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
259            }),
260        }
261    }
262}
263
264/// A Stream of incoming requests for examples.keyvaluestore.usegenericvalues/Store.
265pub struct StoreRequestStream {
266    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
267    is_terminated: bool,
268}
269
270impl std::marker::Unpin for StoreRequestStream {}
271
272impl futures::stream::FusedStream for StoreRequestStream {
273    fn is_terminated(&self) -> bool {
274        self.is_terminated
275    }
276}
277
278impl fidl::endpoints::RequestStream for StoreRequestStream {
279    type Protocol = StoreMarker;
280    type ControlHandle = StoreControlHandle;
281
282    fn from_channel(channel: ::fidl::AsyncChannel) -> Self {
283        Self { inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), is_terminated: false }
284    }
285
286    fn control_handle(&self) -> Self::ControlHandle {
287        StoreControlHandle { inner: self.inner.clone() }
288    }
289
290    fn into_inner(
291        self,
292    ) -> (::std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>, bool)
293    {
294        (self.inner, self.is_terminated)
295    }
296
297    fn from_inner(
298        inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
299        is_terminated: bool,
300    ) -> Self {
301        Self { inner, is_terminated }
302    }
303}
304
305impl futures::Stream for StoreRequestStream {
306    type Item = Result<StoreRequest, fidl::Error>;
307
308    fn poll_next(
309        mut self: std::pin::Pin<&mut Self>,
310        cx: &mut std::task::Context<'_>,
311    ) -> std::task::Poll<Option<Self::Item>> {
312        let this = &mut *self;
313        if this.inner.check_shutdown(cx) {
314            this.is_terminated = true;
315            return std::task::Poll::Ready(None);
316        }
317        if this.is_terminated {
318            panic!("polled StoreRequestStream after completion");
319        }
320        fidl::encoding::with_tls_decode_buf::<_, fidl::encoding::DefaultFuchsiaResourceDialect>(
321            |bytes, handles| {
322                match this.inner.channel().read_etc(cx, bytes, handles) {
323                    std::task::Poll::Ready(Ok(())) => {}
324                    std::task::Poll::Pending => return std::task::Poll::Pending,
325                    std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => {
326                        this.is_terminated = true;
327                        return std::task::Poll::Ready(None);
328                    }
329                    std::task::Poll::Ready(Err(e)) => {
330                        return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(
331                            e.into(),
332                        ))))
333                    }
334                }
335
336                // A message has been received from the channel
337                let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
338
339                std::task::Poll::Ready(Some(match header.ordinal {
340                    0xdbd4bf1e49abe6e => {
341                        header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
342                        let mut req = fidl::new_empty!(
343                            StoreWriteItemRequest,
344                            fidl::encoding::DefaultFuchsiaResourceDialect
345                        );
346                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<StoreWriteItemRequest>(&header, _body_bytes, handles, &mut req)?;
347                        let control_handle = StoreControlHandle { inner: this.inner.clone() };
348                        Ok(StoreRequest::WriteItem {
349                            payload: req,
350                            responder: StoreWriteItemResponder {
351                                control_handle: std::mem::ManuallyDrop::new(control_handle),
352                                tx_id: header.tx_id,
353                            },
354                        })
355                    }
356                    _ if header.tx_id == 0
357                        && header
358                            .dynamic_flags()
359                            .contains(fidl::encoding::DynamicFlags::FLEXIBLE) =>
360                    {
361                        Ok(StoreRequest::_UnknownMethod {
362                            ordinal: header.ordinal,
363                            control_handle: StoreControlHandle { inner: this.inner.clone() },
364                            method_type: fidl::MethodType::OneWay,
365                        })
366                    }
367                    _ if header
368                        .dynamic_flags()
369                        .contains(fidl::encoding::DynamicFlags::FLEXIBLE) =>
370                    {
371                        this.inner.send_framework_err(
372                            fidl::encoding::FrameworkErr::UnknownMethod,
373                            header.tx_id,
374                            header.ordinal,
375                            header.dynamic_flags(),
376                            (bytes, handles),
377                        )?;
378                        Ok(StoreRequest::_UnknownMethod {
379                            ordinal: header.ordinal,
380                            control_handle: StoreControlHandle { inner: this.inner.clone() },
381                            method_type: fidl::MethodType::TwoWay,
382                        })
383                    }
384                    _ => Err(fidl::Error::UnknownOrdinal {
385                        ordinal: header.ordinal,
386                        protocol_name: <StoreMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
387                    }),
388                }))
389            },
390        )
391    }
392}
393
394/// A very basic key-value store.
395#[derive(Debug)]
396pub enum StoreRequest {
397    /// Writes an item to the store.
398    ///
399    /// Since the value stored in the key-value store can now be different from the input (if the
400    /// `WriteOptions.CONCAT` flag is set), we need to return the resulting `Value` to the
401    /// requester.
402    ///
403    /// We use an (anonymous) `table` and a (named) `flexible union` as the request and response
404    /// payload, respectively, to allow for easier future evolution. Both of these types are
405    /// `flexible`, meaning that adding or removing members is binary-compatible. This makes them
406    /// much easier to evolve that the `struct` types that were previously used, which cannot be
407    /// changed after release without breaking ABI.
408    WriteItem { payload: StoreWriteItemRequest, responder: StoreWriteItemResponder },
409    /// An interaction was received which does not match any known method.
410    #[non_exhaustive]
411    _UnknownMethod {
412        /// Ordinal of the method that was called.
413        ordinal: u64,
414        control_handle: StoreControlHandle,
415        method_type: fidl::MethodType,
416    },
417}
418
419impl StoreRequest {
420    #[allow(irrefutable_let_patterns)]
421    pub fn into_write_item(self) -> Option<(StoreWriteItemRequest, StoreWriteItemResponder)> {
422        if let StoreRequest::WriteItem { payload, responder } = self {
423            Some((payload, responder))
424        } else {
425            None
426        }
427    }
428
429    /// Name of the method defined in FIDL
430    pub fn method_name(&self) -> &'static str {
431        match *self {
432            StoreRequest::WriteItem { .. } => "write_item",
433            StoreRequest::_UnknownMethod { method_type: fidl::MethodType::OneWay, .. } => {
434                "unknown one-way method"
435            }
436            StoreRequest::_UnknownMethod { method_type: fidl::MethodType::TwoWay, .. } => {
437                "unknown two-way method"
438            }
439        }
440    }
441}
442
443#[derive(Debug, Clone)]
444pub struct StoreControlHandle {
445    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
446}
447
448impl fidl::endpoints::ControlHandle for StoreControlHandle {
449    fn shutdown(&self) {
450        self.inner.shutdown()
451    }
452    fn shutdown_with_epitaph(&self, status: zx_status::Status) {
453        self.inner.shutdown_with_epitaph(status)
454    }
455
456    fn is_closed(&self) -> bool {
457        self.inner.channel().is_closed()
458    }
459    fn on_closed(&self) -> fidl::OnSignalsRef<'_> {
460        self.inner.channel().on_closed()
461    }
462
463    #[cfg(target_os = "fuchsia")]
464    fn signal_peer(
465        &self,
466        clear_mask: zx::Signals,
467        set_mask: zx::Signals,
468    ) -> Result<(), zx_status::Status> {
469        use fidl::Peered;
470        self.inner.channel().signal_peer(clear_mask, set_mask)
471    }
472}
473
474impl StoreControlHandle {}
475
476#[must_use = "FIDL methods require a response to be sent"]
477#[derive(Debug)]
478pub struct StoreWriteItemResponder {
479    control_handle: std::mem::ManuallyDrop<StoreControlHandle>,
480    tx_id: u32,
481}
482
483/// Set the the channel to be shutdown (see [`StoreControlHandle::shutdown`])
484/// if the responder is dropped without sending a response, so that the client
485/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
486impl std::ops::Drop for StoreWriteItemResponder {
487    fn drop(&mut self) {
488        self.control_handle.shutdown();
489        // Safety: drops once, never accessed again
490        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
491    }
492}
493
494impl fidl::endpoints::Responder for StoreWriteItemResponder {
495    type ControlHandle = StoreControlHandle;
496
497    fn control_handle(&self) -> &StoreControlHandle {
498        &self.control_handle
499    }
500
501    fn drop_without_shutdown(mut self) {
502        // Safety: drops once, never accessed again due to mem::forget
503        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
504        // Prevent Drop from running (which would shut down the channel)
505        std::mem::forget(self);
506    }
507}
508
509impl StoreWriteItemResponder {
510    /// Sends a response to the FIDL transaction.
511    ///
512    /// Sets the channel to shutdown if an error occurs.
513    pub fn send(self, mut result: Result<&Value, WriteError>) -> Result<(), fidl::Error> {
514        let _result = self.send_raw(result);
515        if _result.is_err() {
516            self.control_handle.shutdown();
517        }
518        self.drop_without_shutdown();
519        _result
520    }
521
522    /// Similar to "send" but does not shutdown the channel if an error occurs.
523    pub fn send_no_shutdown_on_err(
524        self,
525        mut result: Result<&Value, WriteError>,
526    ) -> Result<(), fidl::Error> {
527        let _result = self.send_raw(result);
528        self.drop_without_shutdown();
529        _result
530    }
531
532    fn send_raw(&self, mut result: Result<&Value, WriteError>) -> Result<(), fidl::Error> {
533        self.control_handle.inner.send::<fidl::encoding::FlexibleResultType<Value, WriteError>>(
534            fidl::encoding::FlexibleResult::new(result),
535            self.tx_id,
536            0xdbd4bf1e49abe6e,
537            fidl::encoding::DynamicFlags::FLEXIBLE,
538        )
539    }
540}
541
542mod internal {
543    use super::*;
544}
fidl_examples_keyvaluestore_usegenericvalues/fidl_examples_keyvaluestore_usegenericvalues.rs

fidl_examples_keyvaluestore_usegenericvalues/
fidl_examples_keyvaluestore_usegenericvalues.rs
