fidl_fuchsia_power/

fidl_fuchsia_power.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_power_common::*;
use futures::future::{self, MaybeDone, TryFutureExt};
use zx_status;

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

impl fidl::endpoints::ProtocolMarker for CollaborativeRebootInitiatorMarker {
    type Proxy = CollaborativeRebootInitiatorProxy;
    type RequestStream = CollaborativeRebootInitiatorRequestStream;
    #[cfg(target_os = "fuchsia")]
    type SynchronousProxy = CollaborativeRebootInitiatorSynchronousProxy;

    const DEBUG_NAME: &'static str = "fuchsia.power.CollaborativeRebootInitiator";
}
impl fidl::endpoints::DiscoverableProtocolMarker for CollaborativeRebootInitiatorMarker {}

pub trait CollaborativeRebootInitiatorProxyInterface: Send + Sync {
    type PerformPendingRebootResponseFut: std::future::Future<
            Output = Result<CollaborativeRebootInitiatorPerformPendingRebootResponse, fidl::Error>,
        > + Send;
    fn r#perform_pending_reboot(&self) -> Self::PerformPendingRebootResponseFut;
}
#[derive(Debug)]
#[cfg(target_os = "fuchsia")]
pub struct CollaborativeRebootInitiatorSynchronousProxy {
    client: fidl::client::sync::Client,
}

#[cfg(target_os = "fuchsia")]
impl fidl::endpoints::SynchronousProxy for CollaborativeRebootInitiatorSynchronousProxy {
    type Proxy = CollaborativeRebootInitiatorProxy;
    type Protocol = CollaborativeRebootInitiatorMarker;

    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 CollaborativeRebootInitiatorSynchronousProxy {
    pub fn new(channel: fidl::Channel) -> Self {
        let protocol_name =
            <CollaborativeRebootInitiatorMarker 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<CollaborativeRebootInitiatorEvent, fidl::Error> {
        CollaborativeRebootInitiatorEvent::decode(self.client.wait_for_event(deadline)?)
    }

    /// Initiates a collaborative reboot.
    ///
    /// Initiates a device reboot if there is one or more pending reboot
    /// requests from a collaborative reboot scheduler.
    ///
    /// Response:
    /// - rebooting: True if there was a pending reboot request and the device
    ///              will immediately reboot. False if there were no pending
    ///              reboot requests and the device will not reboot.
    pub fn r#perform_pending_reboot(
        &self,
        ___deadline: zx::MonotonicInstant,
    ) -> Result<CollaborativeRebootInitiatorPerformPendingRebootResponse, fidl::Error> {
        let _response = self.client.send_query::<
            fidl::encoding::EmptyPayload,
            CollaborativeRebootInitiatorPerformPendingRebootResponse,
        >(
            (),
            0x6114c8f94a98f492,
            fidl::encoding::DynamicFlags::empty(),
            ___deadline,
        )?;
        Ok(_response)
    }
}

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

impl fidl::endpoints::Proxy for CollaborativeRebootInitiatorProxy {
    type Protocol = CollaborativeRebootInitiatorMarker;

    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 CollaborativeRebootInitiatorProxy {
    /// Create a new Proxy for fuchsia.power/CollaborativeRebootInitiator.
    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
        let protocol_name =
            <CollaborativeRebootInitiatorMarker 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) -> CollaborativeRebootInitiatorEventStream {
        CollaborativeRebootInitiatorEventStream {
            event_receiver: self.client.take_event_receiver(),
        }
    }

    /// Initiates a collaborative reboot.
    ///
    /// Initiates a device reboot if there is one or more pending reboot
    /// requests from a collaborative reboot scheduler.
    ///
    /// Response:
    /// - rebooting: True if there was a pending reboot request and the device
    ///              will immediately reboot. False if there were no pending
    ///              reboot requests and the device will not reboot.
    pub fn r#perform_pending_reboot(
        &self,
    ) -> fidl::client::QueryResponseFut<
        CollaborativeRebootInitiatorPerformPendingRebootResponse,
        fidl::encoding::DefaultFuchsiaResourceDialect,
    > {
        CollaborativeRebootInitiatorProxyInterface::r#perform_pending_reboot(self)
    }
}

impl CollaborativeRebootInitiatorProxyInterface for CollaborativeRebootInitiatorProxy {
    type PerformPendingRebootResponseFut = fidl::client::QueryResponseFut<
        CollaborativeRebootInitiatorPerformPendingRebootResponse,
        fidl::encoding::DefaultFuchsiaResourceDialect,
    >;
    fn r#perform_pending_reboot(&self) -> Self::PerformPendingRebootResponseFut {
        fn _decode(
            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
        ) -> Result<CollaborativeRebootInitiatorPerformPendingRebootResponse, fidl::Error> {
            let _response = fidl::client::decode_transaction_body::<
                CollaborativeRebootInitiatorPerformPendingRebootResponse,
                fidl::encoding::DefaultFuchsiaResourceDialect,
                0x6114c8f94a98f492,
            >(_buf?)?;
            Ok(_response)
        }
        self.client.send_query_and_decode::<
            fidl::encoding::EmptyPayload,
            CollaborativeRebootInitiatorPerformPendingRebootResponse,
        >(
            (),
            0x6114c8f94a98f492,
            fidl::encoding::DynamicFlags::empty(),
            _decode,
        )
    }
}

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

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

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

impl futures::Stream for CollaborativeRebootInitiatorEventStream {
    type Item = Result<CollaborativeRebootInitiatorEvent, 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(CollaborativeRebootInitiatorEvent::decode(buf)))
            }
            None => std::task::Poll::Ready(None),
        }
    }
}

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

impl CollaborativeRebootInitiatorEvent {
    /// Decodes a message buffer as a [`CollaborativeRebootInitiatorEvent`].
    fn decode(
        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
    ) -> Result<CollaborativeRebootInitiatorEvent, 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: <CollaborativeRebootInitiatorMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
            })
        }
    }
}

/// A Stream of incoming requests for fuchsia.power/CollaborativeRebootInitiator.
pub struct CollaborativeRebootInitiatorRequestStream {
    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
    is_terminated: bool,
}

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

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

impl fidl::endpoints::RequestStream for CollaborativeRebootInitiatorRequestStream {
    type Protocol = CollaborativeRebootInitiatorMarker;
    type ControlHandle = CollaborativeRebootInitiatorControlHandle;

    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 {
        CollaborativeRebootInitiatorControlHandle { 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 CollaborativeRebootInitiatorRequestStream {
    type Item = Result<CollaborativeRebootInitiatorRequest, 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 CollaborativeRebootInitiatorRequestStream 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 {
                0x6114c8f94a98f492 => {
                    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 = CollaborativeRebootInitiatorControlHandle {
                        inner: this.inner.clone(),
                    };
                    Ok(CollaborativeRebootInitiatorRequest::PerformPendingReboot {
                        responder: CollaborativeRebootInitiatorPerformPendingRebootResponder {
                            control_handle: std::mem::ManuallyDrop::new(control_handle),
                            tx_id: header.tx_id,
                        },
                    })
                }
                _ => Err(fidl::Error::UnknownOrdinal {
                    ordinal: header.ordinal,
                    protocol_name: <CollaborativeRebootInitiatorMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
                }),
            }))
            },
        )
    }
}

/// An initiator of collaborative device reboots.
///
/// Collaborative reboot is a mechanism that allows multiple actors to work
/// together to schedule a device reboot at a time that avoids user disruption.
/// Actors fulfill one of two roles: Scheduler or Initiator. The scheduler
/// registers the desire to reboot the device at a later point in time, while
/// the initiator identifies appropriate times to perform a reboot and actuates
/// any scheduled requests. This protocol fulfills the initiator role.
///
/// Collaborative reboot can be used when the platform is configured to let the
/// product drive reboot scheduling.
///
/// As a concrete example, this mechanism can be used to drive software updates.
/// When the platform identifies that there is an outstanding software update to
/// apply, it can download the update, and schedule a collaborative reboot.
/// Later, when the product identifies that it is an appropriate time for the
/// device to reboot (say, after it's observed a sufficient period of user
/// inactivity), it can initate the collaborative reboot.
#[derive(Debug)]
pub enum CollaborativeRebootInitiatorRequest {
    /// Initiates a collaborative reboot.
    ///
    /// Initiates a device reboot if there is one or more pending reboot
    /// requests from a collaborative reboot scheduler.
    ///
    /// Response:
    /// - rebooting: True if there was a pending reboot request and the device
    ///              will immediately reboot. False if there were no pending
    ///              reboot requests and the device will not reboot.
    PerformPendingReboot { responder: CollaborativeRebootInitiatorPerformPendingRebootResponder },
}

impl CollaborativeRebootInitiatorRequest {
    #[allow(irrefutable_let_patterns)]
    pub fn into_perform_pending_reboot(
        self,
    ) -> Option<(CollaborativeRebootInitiatorPerformPendingRebootResponder)> {
        if let CollaborativeRebootInitiatorRequest::PerformPendingReboot { responder } = self {
            Some((responder))
        } else {
            None
        }
    }

    /// Name of the method defined in FIDL
    pub fn method_name(&self) -> &'static str {
        match *self {
            CollaborativeRebootInitiatorRequest::PerformPendingReboot { .. } => {
                "perform_pending_reboot"
            }
        }
    }
}

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

impl fidl::endpoints::ControlHandle for CollaborativeRebootInitiatorControlHandle {
    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 CollaborativeRebootInitiatorControlHandle {}

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

/// Set the the channel to be shutdown (see [`CollaborativeRebootInitiatorControlHandle::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 CollaborativeRebootInitiatorPerformPendingRebootResponder {
    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 CollaborativeRebootInitiatorPerformPendingRebootResponder {
    type ControlHandle = CollaborativeRebootInitiatorControlHandle;

    fn control_handle(&self) -> &CollaborativeRebootInitiatorControlHandle {
        &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 CollaborativeRebootInitiatorPerformPendingRebootResponder {
    /// Sends a response to the FIDL transaction.
    ///
    /// Sets the channel to shutdown if an error occurs.
    pub fn send(
        self,
        mut payload: &CollaborativeRebootInitiatorPerformPendingRebootResponse,
    ) -> Result<(), fidl::Error> {
        let _result = self.send_raw(payload);
        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 payload: &CollaborativeRebootInitiatorPerformPendingRebootResponse,
    ) -> Result<(), fidl::Error> {
        let _result = self.send_raw(payload);
        self.drop_without_shutdown();
        _result
    }

    fn send_raw(
        &self,
        mut payload: &CollaborativeRebootInitiatorPerformPendingRebootResponse,
    ) -> Result<(), fidl::Error> {
        self.control_handle.inner.send::<CollaborativeRebootInitiatorPerformPendingRebootResponse>(
            payload,
            self.tx_id,
            0x6114c8f94a98f492,
            fidl::encoding::DynamicFlags::empty(),
        )
    }
}

mod internal {
    use super::*;
}