fidl_fuchsia_time_test/

fidl_fuchsia_time_test.rs

// WARNING: This file is machine generated by fidlgen.

#![warn(clippy::all)]
#![allow(unused_parens, unused_mut, unused_imports, nonstandard_style)]

use bitflags::bitflags;
use fidl::client::QueryResponseFut;
use fidl::encoding::{MessageBufFor, ProxyChannelBox, ResourceDialect};
use fidl::endpoints::{ControlHandle as _, Responder as _};
pub use fidl_fuchsia_time_test_common::*;
use futures::future::{self, MaybeDone, TryFutureExt};
use zx_status;

#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct RtcMarker;

impl fidl::endpoints::ProtocolMarker for RtcMarker {
    type Proxy = RtcProxy;
    type RequestStream = RtcRequestStream;
    #[cfg(target_os = "fuchsia")]
    type SynchronousProxy = RtcSynchronousProxy;

    const DEBUG_NAME: &'static str = "fuchsia.time.test.Rtc";
}
impl fidl::endpoints::DiscoverableProtocolMarker for RtcMarker {}
pub type RtcPersistentDisableResult = Result<(), Error>;
pub type RtcPersistentEnableResult = Result<(), Error>;

pub trait RtcProxyInterface: Send + Sync {
    type PersistentDisableResponseFut: std::future::Future<Output = Result<RtcPersistentDisableResult, fidl::Error>>
        + Send;
    fn r#persistent_disable(&self) -> Self::PersistentDisableResponseFut;
    type PersistentEnableResponseFut: std::future::Future<Output = Result<RtcPersistentEnableResult, fidl::Error>>
        + Send;
    fn r#persistent_enable(&self) -> Self::PersistentEnableResponseFut;
}
#[derive(Debug)]
#[cfg(target_os = "fuchsia")]
pub struct RtcSynchronousProxy {
    client: fidl::client::sync::Client,
}

#[cfg(target_os = "fuchsia")]
impl fidl::endpoints::SynchronousProxy for RtcSynchronousProxy {
    type Proxy = RtcProxy;
    type Protocol = RtcMarker;

    fn from_channel(inner: fidl::Channel) -> Self {
        Self::new(inner)
    }

    fn into_channel(self) -> fidl::Channel {
        self.client.into_channel()
    }

    fn as_channel(&self) -> &fidl::Channel {
        self.client.as_channel()
    }
}

#[cfg(target_os = "fuchsia")]
impl RtcSynchronousProxy {
    pub fn new(channel: fidl::Channel) -> Self {
        let protocol_name = <RtcMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
        Self { client: fidl::client::sync::Client::new(channel, protocol_name) }
    }

    pub fn into_channel(self) -> fidl::Channel {
        self.client.into_channel()
    }

    /// Waits until an event arrives and returns it. It is safe for other
    /// threads to make concurrent requests while waiting for an event.
    pub fn wait_for_event(&self, deadline: zx::MonotonicInstant) -> Result<RtcEvent, fidl::Error> {
        RtcEvent::decode(self.client.wait_for_event(deadline)?)
    }

    /// Call [PersistentDisable] to instruct Timekeeper not to update the RTC with
    /// the latest UTC clock estimate. Once a reply is received, the Timekeeper
    /// will not update the RTC.
    ///
    /// This is useful in tests that exercise the RTC and must therefore write
    /// to it exclusively, possibly entering a race with Timekeeper's own
    /// RTC updates.
    ///
    /// NOTE: The setting persists across reboots, due to the testing
    /// persistence requirements. Implementations should have a way to
    /// limit the number of reboots for which this setting takes effect. This
    /// is to avoid a lasting behavior change resulting from problems in the
    /// test fixture.
    pub fn r#persistent_disable(
        &self,
        ___deadline: zx::MonotonicInstant,
    ) -> Result<RtcPersistentDisableResult, fidl::Error> {
        let _response = self.client.send_query::<
            fidl::encoding::EmptyPayload,
            fidl::encoding::ResultType<fidl::encoding::EmptyStruct, Error>,
        >(
            (),
            0x5773843d951f61c4,
            fidl::encoding::DynamicFlags::empty(),
            ___deadline,
        )?;
        Ok(_response.map(|x| x))
    }

    /// Undoes the effects of [PersistentDisable].
    ///
    /// The test fixture should always attempt to call this method, and have it
    /// succeed. See also the `NOTE` section on [PersistentDisable].
    pub fn r#persistent_enable(
        &self,
        ___deadline: zx::MonotonicInstant,
    ) -> Result<RtcPersistentEnableResult, fidl::Error> {
        let _response = self.client.send_query::<
            fidl::encoding::EmptyPayload,
            fidl::encoding::ResultType<fidl::encoding::EmptyStruct, Error>,
        >(
            (),
            0x6fca18e78537c228,
            fidl::encoding::DynamicFlags::empty(),
            ___deadline,
        )?;
        Ok(_response.map(|x| x))
    }
}

#[cfg(target_os = "fuchsia")]
impl From<RtcSynchronousProxy> for zx::Handle {
    fn from(value: RtcSynchronousProxy) -> Self {
        value.into_channel().into()
    }
}

#[cfg(target_os = "fuchsia")]
impl From<fidl::Channel> for RtcSynchronousProxy {
    fn from(value: fidl::Channel) -> Self {
        Self::new(value)
    }
}

#[derive(Debug, Clone)]
pub struct RtcProxy {
    client: fidl::client::Client<fidl::encoding::DefaultFuchsiaResourceDialect>,
}

impl fidl::endpoints::Proxy for RtcProxy {
    type Protocol = RtcMarker;

    fn from_channel(inner: ::fidl::AsyncChannel) -> Self {
        Self::new(inner)
    }

    fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
        self.client.into_channel().map_err(|client| Self { client })
    }

    fn as_channel(&self) -> &::fidl::AsyncChannel {
        self.client.as_channel()
    }
}

impl RtcProxy {
    /// Create a new Proxy for fuchsia.time.test/Rtc.
    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
        let protocol_name = <RtcMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
        Self { client: fidl::client::Client::new(channel, protocol_name) }
    }

    /// Get a Stream of events from the remote end of the protocol.
    ///
    /// # Panics
    ///
    /// Panics if the event stream was already taken.
    pub fn take_event_stream(&self) -> RtcEventStream {
        RtcEventStream { event_receiver: self.client.take_event_receiver() }
    }

    /// Call [PersistentDisable] to instruct Timekeeper not to update the RTC with
    /// the latest UTC clock estimate. Once a reply is received, the Timekeeper
    /// will not update the RTC.
    ///
    /// This is useful in tests that exercise the RTC and must therefore write
    /// to it exclusively, possibly entering a race with Timekeeper's own
    /// RTC updates.
    ///
    /// NOTE: The setting persists across reboots, due to the testing
    /// persistence requirements. Implementations should have a way to
    /// limit the number of reboots for which this setting takes effect. This
    /// is to avoid a lasting behavior change resulting from problems in the
    /// test fixture.
    pub fn r#persistent_disable(
        &self,
    ) -> fidl::client::QueryResponseFut<
        RtcPersistentDisableResult,
        fidl::encoding::DefaultFuchsiaResourceDialect,
    > {
        RtcProxyInterface::r#persistent_disable(self)
    }

    /// Undoes the effects of [PersistentDisable].
    ///
    /// The test fixture should always attempt to call this method, and have it
    /// succeed. See also the `NOTE` section on [PersistentDisable].
    pub fn r#persistent_enable(
        &self,
    ) -> fidl::client::QueryResponseFut<
        RtcPersistentEnableResult,
        fidl::encoding::DefaultFuchsiaResourceDialect,
    > {
        RtcProxyInterface::r#persistent_enable(self)
    }
}

impl RtcProxyInterface for RtcProxy {
    type PersistentDisableResponseFut = fidl::client::QueryResponseFut<
        RtcPersistentDisableResult,
        fidl::encoding::DefaultFuchsiaResourceDialect,
    >;
    fn r#persistent_disable(&self) -> Self::PersistentDisableResponseFut {
        fn _decode(
            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
        ) -> Result<RtcPersistentDisableResult, fidl::Error> {
            let _response = fidl::client::decode_transaction_body::<
                fidl::encoding::ResultType<fidl::encoding::EmptyStruct, Error>,
                fidl::encoding::DefaultFuchsiaResourceDialect,
                0x5773843d951f61c4,
            >(_buf?)?;
            Ok(_response.map(|x| x))
        }
        self.client
            .send_query_and_decode::<fidl::encoding::EmptyPayload, RtcPersistentDisableResult>(
                (),
                0x5773843d951f61c4,
                fidl::encoding::DynamicFlags::empty(),
                _decode,
            )
    }

    type PersistentEnableResponseFut = fidl::client::QueryResponseFut<
        RtcPersistentEnableResult,
        fidl::encoding::DefaultFuchsiaResourceDialect,
    >;
    fn r#persistent_enable(&self) -> Self::PersistentEnableResponseFut {
        fn _decode(
            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
        ) -> Result<RtcPersistentEnableResult, fidl::Error> {
            let _response = fidl::client::decode_transaction_body::<
                fidl::encoding::ResultType<fidl::encoding::EmptyStruct, Error>,
                fidl::encoding::DefaultFuchsiaResourceDialect,
                0x6fca18e78537c228,
            >(_buf?)?;
            Ok(_response.map(|x| x))
        }
        self.client
            .send_query_and_decode::<fidl::encoding::EmptyPayload, RtcPersistentEnableResult>(
                (),
                0x6fca18e78537c228,
                fidl::encoding::DynamicFlags::empty(),
                _decode,
            )
    }
}

pub struct RtcEventStream {
    event_receiver: fidl::client::EventReceiver<fidl::encoding::DefaultFuchsiaResourceDialect>,
}

impl std::marker::Unpin for RtcEventStream {}

impl futures::stream::FusedStream for RtcEventStream {
    fn is_terminated(&self) -> bool {
        self.event_receiver.is_terminated()
    }
}

impl futures::Stream for RtcEventStream {
    type Item = Result<RtcEvent, fidl::Error>;

    fn poll_next(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Option<Self::Item>> {
        match futures::ready!(futures::stream::StreamExt::poll_next_unpin(
            &mut self.event_receiver,
            cx
        )?) {
            Some(buf) => std::task::Poll::Ready(Some(RtcEvent::decode(buf))),
            None => std::task::Poll::Ready(None),
        }
    }
}

#[derive(Debug)]
pub enum RtcEvent {}

impl RtcEvent {
    /// Decodes a message buffer as a [`RtcEvent`].
    fn decode(
        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
    ) -> Result<RtcEvent, fidl::Error> {
        let (bytes, _handles) = buf.split_mut();
        let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
        debug_assert_eq!(tx_header.tx_id, 0);
        match tx_header.ordinal {
            _ => Err(fidl::Error::UnknownOrdinal {
                ordinal: tx_header.ordinal,
                protocol_name: <RtcMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
            }),
        }
    }
}

/// A Stream of incoming requests for fuchsia.time.test/Rtc.
pub struct RtcRequestStream {
    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
    is_terminated: bool,
}

impl std::marker::Unpin for RtcRequestStream {}

impl futures::stream::FusedStream for RtcRequestStream {
    fn is_terminated(&self) -> bool {
        self.is_terminated
    }
}

impl fidl::endpoints::RequestStream for RtcRequestStream {
    type Protocol = RtcMarker;
    type ControlHandle = RtcControlHandle;

    fn from_channel(channel: ::fidl::AsyncChannel) -> Self {
        Self { inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), is_terminated: false }
    }

    fn control_handle(&self) -> Self::ControlHandle {
        RtcControlHandle { inner: self.inner.clone() }
    }

    fn into_inner(
        self,
    ) -> (::std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>, bool)
    {
        (self.inner, self.is_terminated)
    }

    fn from_inner(
        inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
        is_terminated: bool,
    ) -> Self {
        Self { inner, is_terminated }
    }
}

impl futures::Stream for RtcRequestStream {
    type Item = Result<RtcRequest, fidl::Error>;

    fn poll_next(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Option<Self::Item>> {
        let this = &mut *self;
        if this.inner.check_shutdown(cx) {
            this.is_terminated = true;
            return std::task::Poll::Ready(None);
        }
        if this.is_terminated {
            panic!("polled RtcRequestStream after completion");
        }
        fidl::encoding::with_tls_decode_buf::<_, fidl::encoding::DefaultFuchsiaResourceDialect>(
            |bytes, handles| {
                match this.inner.channel().read_etc(cx, bytes, handles) {
                    std::task::Poll::Ready(Ok(())) => {}
                    std::task::Poll::Pending => return std::task::Poll::Pending,
                    std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => {
                        this.is_terminated = true;
                        return std::task::Poll::Ready(None);
                    }
                    std::task::Poll::Ready(Err(e)) => {
                        return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(
                            e.into(),
                        ))))
                    }
                }

                // A message has been received from the channel
                let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;

                std::task::Poll::Ready(Some(match header.ordinal {
                    0x5773843d951f61c4 => {
                        header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
                        let mut req = fidl::new_empty!(
                            fidl::encoding::EmptyPayload,
                            fidl::encoding::DefaultFuchsiaResourceDialect
                        );
                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<fidl::encoding::EmptyPayload>(&header, _body_bytes, handles, &mut req)?;
                        let control_handle = RtcControlHandle { inner: this.inner.clone() };
                        Ok(RtcRequest::PersistentDisable {
                            responder: RtcPersistentDisableResponder {
                                control_handle: std::mem::ManuallyDrop::new(control_handle),
                                tx_id: header.tx_id,
                            },
                        })
                    }
                    0x6fca18e78537c228 => {
                        header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
                        let mut req = fidl::new_empty!(
                            fidl::encoding::EmptyPayload,
                            fidl::encoding::DefaultFuchsiaResourceDialect
                        );
                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<fidl::encoding::EmptyPayload>(&header, _body_bytes, handles, &mut req)?;
                        let control_handle = RtcControlHandle { inner: this.inner.clone() };
                        Ok(RtcRequest::PersistentEnable {
                            responder: RtcPersistentEnableResponder {
                                control_handle: std::mem::ManuallyDrop::new(control_handle),
                                tx_id: header.tx_id,
                            },
                        })
                    }
                    _ => Err(fidl::Error::UnknownOrdinal {
                        ordinal: header.ordinal,
                        protocol_name: <RtcMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
                    }),
                }))
            },
        )
    }
}

/// Connect to the RTC protocol to send messages to Timekeeper instructing it
/// to modify its default behavior for testing purposes.
///
/// On devices that do not have a real time clock, this protocol is not useful.
#[derive(Debug)]
pub enum RtcRequest {
    /// Call [PersistentDisable] to instruct Timekeeper not to update the RTC with
    /// the latest UTC clock estimate. Once a reply is received, the Timekeeper
    /// will not update the RTC.
    ///
    /// This is useful in tests that exercise the RTC and must therefore write
    /// to it exclusively, possibly entering a race with Timekeeper's own
    /// RTC updates.
    ///
    /// NOTE: The setting persists across reboots, due to the testing
    /// persistence requirements. Implementations should have a way to
    /// limit the number of reboots for which this setting takes effect. This
    /// is to avoid a lasting behavior change resulting from problems in the
    /// test fixture.
    PersistentDisable { responder: RtcPersistentDisableResponder },
    /// Undoes the effects of [PersistentDisable].
    ///
    /// The test fixture should always attempt to call this method, and have it
    /// succeed. See also the `NOTE` section on [PersistentDisable].
    PersistentEnable { responder: RtcPersistentEnableResponder },
}

impl RtcRequest {
    #[allow(irrefutable_let_patterns)]
    pub fn into_persistent_disable(self) -> Option<(RtcPersistentDisableResponder)> {
        if let RtcRequest::PersistentDisable { responder } = self {
            Some((responder))
        } else {
            None
        }
    }

    #[allow(irrefutable_let_patterns)]
    pub fn into_persistent_enable(self) -> Option<(RtcPersistentEnableResponder)> {
        if let RtcRequest::PersistentEnable { responder } = self {
            Some((responder))
        } else {
            None
        }
    }

    /// Name of the method defined in FIDL
    pub fn method_name(&self) -> &'static str {
        match *self {
            RtcRequest::PersistentDisable { .. } => "persistent_disable",
            RtcRequest::PersistentEnable { .. } => "persistent_enable",
        }
    }
}

#[derive(Debug, Clone)]
pub struct RtcControlHandle {
    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
}

impl fidl::endpoints::ControlHandle for RtcControlHandle {
    fn shutdown(&self) {
        self.inner.shutdown()
    }
    fn shutdown_with_epitaph(&self, status: zx_status::Status) {
        self.inner.shutdown_with_epitaph(status)
    }

    fn is_closed(&self) -> bool {
        self.inner.channel().is_closed()
    }
    fn on_closed(&self) -> fidl::OnSignalsRef<'_> {
        self.inner.channel().on_closed()
    }

    #[cfg(target_os = "fuchsia")]
    fn signal_peer(
        &self,
        clear_mask: zx::Signals,
        set_mask: zx::Signals,
    ) -> Result<(), zx_status::Status> {
        use fidl::Peered;
        self.inner.channel().signal_peer(clear_mask, set_mask)
    }
}

impl RtcControlHandle {}

#[must_use = "FIDL methods require a response to be sent"]
#[derive(Debug)]
pub struct RtcPersistentDisableResponder {
    control_handle: std::mem::ManuallyDrop<RtcControlHandle>,
    tx_id: u32,
}

/// Set the the channel to be shutdown (see [`RtcControlHandle::shutdown`])
/// if the responder is dropped without sending a response, so that the client
/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
impl std::ops::Drop for RtcPersistentDisableResponder {
    fn drop(&mut self) {
        self.control_handle.shutdown();
        // Safety: drops once, never accessed again
        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
    }
}

impl fidl::endpoints::Responder for RtcPersistentDisableResponder {
    type ControlHandle = RtcControlHandle;

    fn control_handle(&self) -> &RtcControlHandle {
        &self.control_handle
    }

    fn drop_without_shutdown(mut self) {
        // Safety: drops once, never accessed again due to mem::forget
        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
        // Prevent Drop from running (which would shut down the channel)
        std::mem::forget(self);
    }
}

impl RtcPersistentDisableResponder {
    /// Sends a response to the FIDL transaction.
    ///
    /// Sets the channel to shutdown if an error occurs.
    pub fn send(self, mut result: Result<(), Error>) -> Result<(), fidl::Error> {
        let _result = self.send_raw(result);
        if _result.is_err() {
            self.control_handle.shutdown();
        }
        self.drop_without_shutdown();
        _result
    }

    /// Similar to "send" but does not shutdown the channel if an error occurs.
    pub fn send_no_shutdown_on_err(self, mut result: Result<(), Error>) -> Result<(), fidl::Error> {
        let _result = self.send_raw(result);
        self.drop_without_shutdown();
        _result
    }

    fn send_raw(&self, mut result: Result<(), Error>) -> Result<(), fidl::Error> {
        self.control_handle
            .inner
            .send::<fidl::encoding::ResultType<fidl::encoding::EmptyStruct, Error>>(
                result,
                self.tx_id,
                0x5773843d951f61c4,
                fidl::encoding::DynamicFlags::empty(),
            )
    }
}

#[must_use = "FIDL methods require a response to be sent"]
#[derive(Debug)]
pub struct RtcPersistentEnableResponder {
    control_handle: std::mem::ManuallyDrop<RtcControlHandle>,
    tx_id: u32,
}

/// Set the the channel to be shutdown (see [`RtcControlHandle::shutdown`])
/// if the responder is dropped without sending a response, so that the client
/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
impl std::ops::Drop for RtcPersistentEnableResponder {
    fn drop(&mut self) {
        self.control_handle.shutdown();
        // Safety: drops once, never accessed again
        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
    }
}

impl fidl::endpoints::Responder for RtcPersistentEnableResponder {
    type ControlHandle = RtcControlHandle;

    fn control_handle(&self) -> &RtcControlHandle {
        &self.control_handle
    }

    fn drop_without_shutdown(mut self) {
        // Safety: drops once, never accessed again due to mem::forget
        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
        // Prevent Drop from running (which would shut down the channel)
        std::mem::forget(self);
    }
}

impl RtcPersistentEnableResponder {
    /// Sends a response to the FIDL transaction.
    ///
    /// Sets the channel to shutdown if an error occurs.
    pub fn send(self, mut result: Result<(), Error>) -> Result<(), fidl::Error> {
        let _result = self.send_raw(result);
        if _result.is_err() {
            self.control_handle.shutdown();
        }
        self.drop_without_shutdown();
        _result
    }

    /// Similar to "send" but does not shutdown the channel if an error occurs.
    pub fn send_no_shutdown_on_err(self, mut result: Result<(), Error>) -> Result<(), fidl::Error> {
        let _result = self.send_raw(result);
        self.drop_without_shutdown();
        _result
    }

    fn send_raw(&self, mut result: Result<(), Error>) -> Result<(), fidl::Error> {
        self.control_handle
            .inner
            .send::<fidl::encoding::ResultType<fidl::encoding::EmptyStruct, Error>>(
                result,
                self.tx_id,
                0x6fca18e78537c228,
                fidl::encoding::DynamicFlags::empty(),
            )
    }
}

mod internal {
    use super::*;
}