fidl_fuchsia_time/
fidl_fuchsia_time.rs

Help
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_time__common::*;
11use futures::future::{self, MaybeDone, TryFutureExt};
12use zx_status;
13
14#[derive(Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
15pub struct MaintenanceGetWritableUtcClockResponse {
16    pub utc_clock: fidl::Clock,
17}
18
19impl fidl::Standalone<fidl::encoding::DefaultFuchsiaResourceDialect>
20    for MaintenanceGetWritableUtcClockResponse
21{
22}
23
24#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
25pub struct MaintenanceMarker;
26
27impl fidl::endpoints::ProtocolMarker for MaintenanceMarker {
28    type Proxy = MaintenanceProxy;
29    type RequestStream = MaintenanceRequestStream;
30    #[cfg(target_os = "fuchsia")]
31    type SynchronousProxy = MaintenanceSynchronousProxy;
32
33    const DEBUG_NAME: &'static str = "fuchsia.time.Maintenance";
34}
35impl fidl::endpoints::DiscoverableProtocolMarker for MaintenanceMarker {}
36
37pub trait MaintenanceProxyInterface: Send + Sync {
38    type GetWritableUtcClockResponseFut: std::future::Future<Output = Result<fidl::Clock, fidl::Error>>
39        + Send;
40    fn r#get_writable_utc_clock(&self) -> Self::GetWritableUtcClockResponseFut;
41}
42#[derive(Debug)]
43#[cfg(target_os = "fuchsia")]
44pub struct MaintenanceSynchronousProxy {
45    client: fidl::client::sync::Client,
46}
47
48#[cfg(target_os = "fuchsia")]
49impl fidl::endpoints::SynchronousProxy for MaintenanceSynchronousProxy {
50    type Proxy = MaintenanceProxy;
51    type Protocol = MaintenanceMarker;
52
53    fn from_channel(inner: fidl::Channel) -> Self {
54        Self::new(inner)
55    }
56
57    fn into_channel(self) -> fidl::Channel {
58        self.client.into_channel()
59    }
60
61    fn as_channel(&self) -> &fidl::Channel {
62        self.client.as_channel()
63    }
64}
65
66#[cfg(target_os = "fuchsia")]
67impl MaintenanceSynchronousProxy {
68    pub fn new(channel: fidl::Channel) -> Self {
69        let protocol_name = <MaintenanceMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
70        Self { client: fidl::client::sync::Client::new(channel, protocol_name) }
71    }
72
73    pub fn into_channel(self) -> fidl::Channel {
74        self.client.into_channel()
75    }
76
77    /// Waits until an event arrives and returns it. It is safe for other
78    /// threads to make concurrent requests while waiting for an event.
79    pub fn wait_for_event(
80        &self,
81        deadline: zx::MonotonicInstant,
82    ) -> Result<MaintenanceEvent, fidl::Error> {
83        MaintenanceEvent::decode(self.client.wait_for_event(deadline)?)
84    }
85
86    /// Retrieve a UTC clock handle with write rights.
87    pub fn r#get_writable_utc_clock(
88        &self,
89        ___deadline: zx::MonotonicInstant,
90    ) -> Result<fidl::Clock, fidl::Error> {
91        let _response = self
92            .client
93            .send_query::<fidl::encoding::EmptyPayload, MaintenanceGetWritableUtcClockResponse>(
94                (),
95                0x7e4ff4ceb95bb136,
96                fidl::encoding::DynamicFlags::empty(),
97                ___deadline,
98            )?;
99        Ok(_response.utc_clock)
100    }
101}
102
103#[cfg(target_os = "fuchsia")]
104impl From<MaintenanceSynchronousProxy> for zx::Handle {
105    fn from(value: MaintenanceSynchronousProxy) -> Self {
106        value.into_channel().into()
107    }
108}
109
110#[cfg(target_os = "fuchsia")]
111impl From<fidl::Channel> for MaintenanceSynchronousProxy {
112    fn from(value: fidl::Channel) -> Self {
113        Self::new(value)
114    }
115}
116
117#[derive(Debug, Clone)]
118pub struct MaintenanceProxy {
119    client: fidl::client::Client<fidl::encoding::DefaultFuchsiaResourceDialect>,
120}
121
122impl fidl::endpoints::Proxy for MaintenanceProxy {
123    type Protocol = MaintenanceMarker;
124
125    fn from_channel(inner: ::fidl::AsyncChannel) -> Self {
126        Self::new(inner)
127    }
128
129    fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
130        self.client.into_channel().map_err(|client| Self { client })
131    }
132
133    fn as_channel(&self) -> &::fidl::AsyncChannel {
134        self.client.as_channel()
135    }
136}
137
138impl MaintenanceProxy {
139    /// Create a new Proxy for fuchsia.time/Maintenance.
140    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
141        let protocol_name = <MaintenanceMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
142        Self { client: fidl::client::Client::new(channel, protocol_name) }
143    }
144
145    /// Get a Stream of events from the remote end of the protocol.
146    ///
147    /// # Panics
148    ///
149    /// Panics if the event stream was already taken.
150    pub fn take_event_stream(&self) -> MaintenanceEventStream {
151        MaintenanceEventStream { event_receiver: self.client.take_event_receiver() }
152    }
153
154    /// Retrieve a UTC clock handle with write rights.
155    pub fn r#get_writable_utc_clock(
156        &self,
157    ) -> fidl::client::QueryResponseFut<fidl::Clock, fidl::encoding::DefaultFuchsiaResourceDialect>
158    {
159        MaintenanceProxyInterface::r#get_writable_utc_clock(self)
160    }
161}
162
163impl MaintenanceProxyInterface for MaintenanceProxy {
164    type GetWritableUtcClockResponseFut =
165        fidl::client::QueryResponseFut<fidl::Clock, fidl::encoding::DefaultFuchsiaResourceDialect>;
166    fn r#get_writable_utc_clock(&self) -> Self::GetWritableUtcClockResponseFut {
167        fn _decode(
168            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
169        ) -> Result<fidl::Clock, fidl::Error> {
170            let _response = fidl::client::decode_transaction_body::<
171                MaintenanceGetWritableUtcClockResponse,
172                fidl::encoding::DefaultFuchsiaResourceDialect,
173                0x7e4ff4ceb95bb136,
174            >(_buf?)?;
175            Ok(_response.utc_clock)
176        }
177        self.client.send_query_and_decode::<fidl::encoding::EmptyPayload, fidl::Clock>(
178            (),
179            0x7e4ff4ceb95bb136,
180            fidl::encoding::DynamicFlags::empty(),
181            _decode,
182        )
183    }
184}
185
186pub struct MaintenanceEventStream {
187    event_receiver: fidl::client::EventReceiver<fidl::encoding::DefaultFuchsiaResourceDialect>,
188}
189
190impl std::marker::Unpin for MaintenanceEventStream {}
191
192impl futures::stream::FusedStream for MaintenanceEventStream {
193    fn is_terminated(&self) -> bool {
194        self.event_receiver.is_terminated()
195    }
196}
197
198impl futures::Stream for MaintenanceEventStream {
199    type Item = Result<MaintenanceEvent, fidl::Error>;
200
201    fn poll_next(
202        mut self: std::pin::Pin<&mut Self>,
203        cx: &mut std::task::Context<'_>,
204    ) -> std::task::Poll<Option<Self::Item>> {
205        match futures::ready!(futures::stream::StreamExt::poll_next_unpin(
206            &mut self.event_receiver,
207            cx
208        )?) {
209            Some(buf) => std::task::Poll::Ready(Some(MaintenanceEvent::decode(buf))),
210            None => std::task::Poll::Ready(None),
211        }
212    }
213}
214
215#[derive(Debug)]
216pub enum MaintenanceEvent {}
217
218impl MaintenanceEvent {
219    /// Decodes a message buffer as a [`MaintenanceEvent`].
220    fn decode(
221        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
222    ) -> Result<MaintenanceEvent, fidl::Error> {
223        let (bytes, _handles) = buf.split_mut();
224        let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
225        debug_assert_eq!(tx_header.tx_id, 0);
226        match tx_header.ordinal {
227            _ => Err(fidl::Error::UnknownOrdinal {
228                ordinal: tx_header.ordinal,
229                protocol_name: <MaintenanceMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
230            }),
231        }
232    }
233}
234
235/// A Stream of incoming requests for fuchsia.time/Maintenance.
236pub struct MaintenanceRequestStream {
237    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
238    is_terminated: bool,
239}
240
241impl std::marker::Unpin for MaintenanceRequestStream {}
242
243impl futures::stream::FusedStream for MaintenanceRequestStream {
244    fn is_terminated(&self) -> bool {
245        self.is_terminated
246    }
247}
248
249impl fidl::endpoints::RequestStream for MaintenanceRequestStream {
250    type Protocol = MaintenanceMarker;
251    type ControlHandle = MaintenanceControlHandle;
252
253    fn from_channel(channel: ::fidl::AsyncChannel) -> Self {
254        Self { inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), is_terminated: false }
255    }
256
257    fn control_handle(&self) -> Self::ControlHandle {
258        MaintenanceControlHandle { inner: self.inner.clone() }
259    }
260
261    fn into_inner(
262        self,
263    ) -> (::std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>, bool)
264    {
265        (self.inner, self.is_terminated)
266    }
267
268    fn from_inner(
269        inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
270        is_terminated: bool,
271    ) -> Self {
272        Self { inner, is_terminated }
273    }
274}
275
276impl futures::Stream for MaintenanceRequestStream {
277    type Item = Result<MaintenanceRequest, fidl::Error>;
278
279    fn poll_next(
280        mut self: std::pin::Pin<&mut Self>,
281        cx: &mut std::task::Context<'_>,
282    ) -> std::task::Poll<Option<Self::Item>> {
283        let this = &mut *self;
284        if this.inner.check_shutdown(cx) {
285            this.is_terminated = true;
286            return std::task::Poll::Ready(None);
287        }
288        if this.is_terminated {
289            panic!("polled MaintenanceRequestStream after completion");
290        }
291        fidl::encoding::with_tls_decode_buf::<_, fidl::encoding::DefaultFuchsiaResourceDialect>(
292            |bytes, handles| {
293                match this.inner.channel().read_etc(cx, bytes, handles) {
294                    std::task::Poll::Ready(Ok(())) => {}
295                    std::task::Poll::Pending => return std::task::Poll::Pending,
296                    std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => {
297                        this.is_terminated = true;
298                        return std::task::Poll::Ready(None);
299                    }
300                    std::task::Poll::Ready(Err(e)) => {
301                        return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(
302                            e.into(),
303                        ))))
304                    }
305                }
306
307                // A message has been received from the channel
308                let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
309
310                std::task::Poll::Ready(Some(match header.ordinal {
311                    0x7e4ff4ceb95bb136 => {
312                        header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
313                        let mut req = fidl::new_empty!(
314                            fidl::encoding::EmptyPayload,
315                            fidl::encoding::DefaultFuchsiaResourceDialect
316                        );
317                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<fidl::encoding::EmptyPayload>(&header, _body_bytes, handles, &mut req)?;
318                        let control_handle = MaintenanceControlHandle { inner: this.inner.clone() };
319                        Ok(MaintenanceRequest::GetWritableUtcClock {
320                            responder: MaintenanceGetWritableUtcClockResponder {
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                            <MaintenanceMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
330                    }),
331                }))
332            },
333        )
334    }
335}
336
337/// Provides access to a UTC clock for the purposes of
338/// keeping it up-to-date with external time sources.
339///
340/// The client does not own the UTC clock, but is given
341/// a lease in order to keep the time synchronized.
342#[derive(Debug)]
343pub enum MaintenanceRequest {
344    /// Retrieve a UTC clock handle with write rights.
345    GetWritableUtcClock { responder: MaintenanceGetWritableUtcClockResponder },
346}
347
348impl MaintenanceRequest {
349    #[allow(irrefutable_let_patterns)]
350    pub fn into_get_writable_utc_clock(self) -> Option<(MaintenanceGetWritableUtcClockResponder)> {
351        if let MaintenanceRequest::GetWritableUtcClock { responder } = self {
352            Some((responder))
353        } else {
354            None
355        }
356    }
357
358    /// Name of the method defined in FIDL
359    pub fn method_name(&self) -> &'static str {
360        match *self {
361            MaintenanceRequest::GetWritableUtcClock { .. } => "get_writable_utc_clock",
362        }
363    }
364}
365
366#[derive(Debug, Clone)]
367pub struct MaintenanceControlHandle {
368    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
369}
370
371impl fidl::endpoints::ControlHandle for MaintenanceControlHandle {
372    fn shutdown(&self) {
373        self.inner.shutdown()
374    }
375    fn shutdown_with_epitaph(&self, status: zx_status::Status) {
376        self.inner.shutdown_with_epitaph(status)
377    }
378
379    fn is_closed(&self) -> bool {
380        self.inner.channel().is_closed()
381    }
382    fn on_closed(&self) -> fidl::OnSignalsRef<'_> {
383        self.inner.channel().on_closed()
384    }
385
386    #[cfg(target_os = "fuchsia")]
387    fn signal_peer(
388        &self,
389        clear_mask: zx::Signals,
390        set_mask: zx::Signals,
391    ) -> Result<(), zx_status::Status> {
392        use fidl::Peered;
393        self.inner.channel().signal_peer(clear_mask, set_mask)
394    }
395}
396
397impl MaintenanceControlHandle {}
398
399#[must_use = "FIDL methods require a response to be sent"]
400#[derive(Debug)]
401pub struct MaintenanceGetWritableUtcClockResponder {
402    control_handle: std::mem::ManuallyDrop<MaintenanceControlHandle>,
403    tx_id: u32,
404}
405
406/// Set the the channel to be shutdown (see [`MaintenanceControlHandle::shutdown`])
407/// if the responder is dropped without sending a response, so that the client
408/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
409impl std::ops::Drop for MaintenanceGetWritableUtcClockResponder {
410    fn drop(&mut self) {
411        self.control_handle.shutdown();
412        // Safety: drops once, never accessed again
413        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
414    }
415}
416
417impl fidl::endpoints::Responder for MaintenanceGetWritableUtcClockResponder {
418    type ControlHandle = MaintenanceControlHandle;
419
420    fn control_handle(&self) -> &MaintenanceControlHandle {
421        &self.control_handle
422    }
423
424    fn drop_without_shutdown(mut self) {
425        // Safety: drops once, never accessed again due to mem::forget
426        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
427        // Prevent Drop from running (which would shut down the channel)
428        std::mem::forget(self);
429    }
430}
431
432impl MaintenanceGetWritableUtcClockResponder {
433    /// Sends a response to the FIDL transaction.
434    ///
435    /// Sets the channel to shutdown if an error occurs.
436    pub fn send(self, mut utc_clock: fidl::Clock) -> Result<(), fidl::Error> {
437        let _result = self.send_raw(utc_clock);
438        if _result.is_err() {
439            self.control_handle.shutdown();
440        }
441        self.drop_without_shutdown();
442        _result
443    }
444
445    /// Similar to "send" but does not shutdown the channel if an error occurs.
446    pub fn send_no_shutdown_on_err(self, mut utc_clock: fidl::Clock) -> Result<(), fidl::Error> {
447        let _result = self.send_raw(utc_clock);
448        self.drop_without_shutdown();
449        _result
450    }
451
452    fn send_raw(&self, mut utc_clock: fidl::Clock) -> Result<(), fidl::Error> {
453        self.control_handle.inner.send::<MaintenanceGetWritableUtcClockResponse>(
454            (utc_clock,),
455            self.tx_id,
456            0x7e4ff4ceb95bb136,
457            fidl::encoding::DynamicFlags::empty(),
458        )
459    }
460}
461
462mod internal {
463    use super::*;
464
465    impl fidl::encoding::ResourceTypeMarker for MaintenanceGetWritableUtcClockResponse {
466        type Borrowed<'a> = &'a mut Self;
467        fn take_or_borrow<'a>(
468            value: &'a mut <Self as fidl::encoding::TypeMarker>::Owned,
469        ) -> Self::Borrowed<'a> {
470            value
471        }
472    }
473
474    unsafe impl fidl::encoding::TypeMarker for MaintenanceGetWritableUtcClockResponse {
475        type Owned = Self;
476
477        #[inline(always)]
478        fn inline_align(_context: fidl::encoding::Context) -> usize {
479            4
480        }
481
482        #[inline(always)]
483        fn inline_size(_context: fidl::encoding::Context) -> usize {
484            4
485        }
486    }
487
488    unsafe impl
489        fidl::encoding::Encode<
490            MaintenanceGetWritableUtcClockResponse,
491            fidl::encoding::DefaultFuchsiaResourceDialect,
492        > for &mut MaintenanceGetWritableUtcClockResponse
493    {
494        #[inline]
495        unsafe fn encode(
496            self,
497            encoder: &mut fidl::encoding::Encoder<
498                '_,
499                fidl::encoding::DefaultFuchsiaResourceDialect,
500            >,
501            offset: usize,
502            _depth: fidl::encoding::Depth,
503        ) -> fidl::Result<()> {
504            encoder.debug_check_bounds::<MaintenanceGetWritableUtcClockResponse>(offset);
505            // Delegate to tuple encoding.
506            fidl::encoding::Encode::<
507                MaintenanceGetWritableUtcClockResponse,
508                fidl::encoding::DefaultFuchsiaResourceDialect,
509            >::encode(
510                (<fidl::encoding::HandleType<
511                    fidl::Clock,
512                    { fidl::ObjectType::CLOCK.into_raw() },
513                    2147483648,
514                > as fidl::encoding::ResourceTypeMarker>::take_or_borrow(
515                    &mut self.utc_clock
516                ),),
517                encoder,
518                offset,
519                _depth,
520            )
521        }
522    }
523    unsafe impl<
524            T0: fidl::encoding::Encode<
525                fidl::encoding::HandleType<
526                    fidl::Clock,
527                    { fidl::ObjectType::CLOCK.into_raw() },
528                    2147483648,
529                >,
530                fidl::encoding::DefaultFuchsiaResourceDialect,
531            >,
532        >
533        fidl::encoding::Encode<
534            MaintenanceGetWritableUtcClockResponse,
535            fidl::encoding::DefaultFuchsiaResourceDialect,
536        > for (T0,)
537    {
538        #[inline]
539        unsafe fn encode(
540            self,
541            encoder: &mut fidl::encoding::Encoder<
542                '_,
543                fidl::encoding::DefaultFuchsiaResourceDialect,
544            >,
545            offset: usize,
546            depth: fidl::encoding::Depth,
547        ) -> fidl::Result<()> {
548            encoder.debug_check_bounds::<MaintenanceGetWritableUtcClockResponse>(offset);
549            // Zero out padding regions. There's no need to apply masks
550            // because the unmasked parts will be overwritten by fields.
551            // Write the fields.
552            self.0.encode(encoder, offset + 0, depth)?;
553            Ok(())
554        }
555    }
556
557    impl fidl::encoding::Decode<Self, fidl::encoding::DefaultFuchsiaResourceDialect>
558        for MaintenanceGetWritableUtcClockResponse
559    {
560        #[inline(always)]
561        fn new_empty() -> Self {
562            Self {
563                utc_clock: fidl::new_empty!(fidl::encoding::HandleType<fidl::Clock, { fidl::ObjectType::CLOCK.into_raw() }, 2147483648>, fidl::encoding::DefaultFuchsiaResourceDialect),
564            }
565        }
566
567        #[inline]
568        unsafe fn decode(
569            &mut self,
570            decoder: &mut fidl::encoding::Decoder<
571                '_,
572                fidl::encoding::DefaultFuchsiaResourceDialect,
573            >,
574            offset: usize,
575            _depth: fidl::encoding::Depth,
576        ) -> fidl::Result<()> {
577            decoder.debug_check_bounds::<Self>(offset);
578            // Verify that padding bytes are zero.
579            fidl::decode!(fidl::encoding::HandleType<fidl::Clock, { fidl::ObjectType::CLOCK.into_raw() }, 2147483648>, fidl::encoding::DefaultFuchsiaResourceDialect, &mut self.utc_clock, decoder, offset + 0, _depth)?;
580            Ok(())
581        }
582    }
583}
fidl_fuchsia_time/fidl_fuchsia_time.rs

fidl_fuchsia_time/
fidl_fuchsia_time.rs
