fidl_fuchsia_storage_blobfs/

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

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

impl fidl::endpoints::ProtocolMarker for OverwriteConfigurationMarker {
    type Proxy = OverwriteConfigurationProxy;
    type RequestStream = OverwriteConfigurationRequestStream;
    #[cfg(target_os = "fuchsia")]
    type SynchronousProxy = OverwriteConfigurationSynchronousProxy;

    const DEBUG_NAME: &'static str = "fuchsia.storage.blobfs.OverwriteConfiguration";
}
impl fidl::endpoints::DiscoverableProtocolMarker for OverwriteConfigurationMarker {}
pub type OverwriteConfigurationSetResult = Result<(), i32>;

pub trait OverwriteConfigurationProxyInterface: Send + Sync {
    type SetResponseFut: std::future::Future<Output = Result<OverwriteConfigurationSetResult, fidl::Error>>
        + Send;
    fn r#set(&self, overwrite_format: OverwriteFormat) -> Self::SetResponseFut;
}
#[derive(Debug)]
#[cfg(target_os = "fuchsia")]
pub struct OverwriteConfigurationSynchronousProxy {
    client: fidl::client::sync::Client,
}

#[cfg(target_os = "fuchsia")]
impl fidl::endpoints::SynchronousProxy for OverwriteConfigurationSynchronousProxy {
    type Proxy = OverwriteConfigurationProxy;
    type Protocol = OverwriteConfigurationMarker;

    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 OverwriteConfigurationSynchronousProxy {
    pub fn new(channel: fidl::Channel) -> Self {
        Self { client: fidl::client::sync::Client::new(channel) }
    }

    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<OverwriteConfigurationEvent, fidl::Error> {
        OverwriteConfigurationEvent::decode(
            self.client.wait_for_event::<OverwriteConfigurationMarker>(deadline)?,
        )
    }

    /// Set the current configuration.
    pub fn r#set(
        &self,
        mut overwrite_format: OverwriteFormat,
        ___deadline: zx::MonotonicInstant,
    ) -> Result<OverwriteConfigurationSetResult, fidl::Error> {
        let _response = self.client.send_query::<
            OverwriteConfigurationSetRequest,
            fidl::encoding::ResultType<fidl::encoding::EmptyStruct, i32>,
            OverwriteConfigurationMarker,
        >(
            (overwrite_format,),
            0x756a2a36396e0e08,
            fidl::encoding::DynamicFlags::empty(),
            ___deadline,
        )?;
        Ok(_response.map(|x| x))
    }
}

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

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

#[cfg(target_os = "fuchsia")]
impl fidl::endpoints::FromClient for OverwriteConfigurationSynchronousProxy {
    type Protocol = OverwriteConfigurationMarker;

    fn from_client(value: fidl::endpoints::ClientEnd<OverwriteConfigurationMarker>) -> Self {
        Self::new(value.into_channel())
    }
}

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

impl fidl::endpoints::Proxy for OverwriteConfigurationProxy {
    type Protocol = OverwriteConfigurationMarker;

    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 OverwriteConfigurationProxy {
    /// Create a new Proxy for fuchsia.storage.blobfs/OverwriteConfiguration.
    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
        let protocol_name =
            <OverwriteConfigurationMarker 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) -> OverwriteConfigurationEventStream {
        OverwriteConfigurationEventStream { event_receiver: self.client.take_event_receiver() }
    }

    /// Set the current configuration.
    pub fn r#set(
        &self,
        mut overwrite_format: OverwriteFormat,
    ) -> fidl::client::QueryResponseFut<
        OverwriteConfigurationSetResult,
        fidl::encoding::DefaultFuchsiaResourceDialect,
    > {
        OverwriteConfigurationProxyInterface::r#set(self, overwrite_format)
    }
}

impl OverwriteConfigurationProxyInterface for OverwriteConfigurationProxy {
    type SetResponseFut = fidl::client::QueryResponseFut<
        OverwriteConfigurationSetResult,
        fidl::encoding::DefaultFuchsiaResourceDialect,
    >;
    fn r#set(&self, mut overwrite_format: OverwriteFormat) -> Self::SetResponseFut {
        fn _decode(
            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
        ) -> Result<OverwriteConfigurationSetResult, fidl::Error> {
            let _response = fidl::client::decode_transaction_body::<
                fidl::encoding::ResultType<fidl::encoding::EmptyStruct, i32>,
                fidl::encoding::DefaultFuchsiaResourceDialect,
                0x756a2a36396e0e08,
            >(_buf?)?;
            Ok(_response.map(|x| x))
        }
        self.client.send_query_and_decode::<
            OverwriteConfigurationSetRequest,
            OverwriteConfigurationSetResult,
        >(
            (overwrite_format,),
            0x756a2a36396e0e08,
            fidl::encoding::DynamicFlags::empty(),
            _decode,
        )
    }
}

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

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

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

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

#[derive(Debug)]
pub enum OverwriteConfigurationEvent {
    #[non_exhaustive]
    _UnknownEvent {
        /// Ordinal of the event that was sent.
        ordinal: u64,
    },
}

impl OverwriteConfigurationEvent {
    /// Decodes a message buffer as a [`OverwriteConfigurationEvent`].
    fn decode(
        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
    ) -> Result<OverwriteConfigurationEvent, 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 {
            _ if tx_header.dynamic_flags().contains(fidl::encoding::DynamicFlags::FLEXIBLE) => {
                Ok(OverwriteConfigurationEvent::_UnknownEvent { ordinal: tx_header.ordinal })
            }
            _ => Err(fidl::Error::UnknownOrdinal {
                ordinal: tx_header.ordinal,
                protocol_name:
                    <OverwriteConfigurationMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
            }),
        }
    }
}

/// A Stream of incoming requests for fuchsia.storage.blobfs/OverwriteConfiguration.
pub struct OverwriteConfigurationRequestStream {
    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
    is_terminated: bool,
}

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

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

impl fidl::endpoints::RequestStream for OverwriteConfigurationRequestStream {
    type Protocol = OverwriteConfigurationMarker;
    type ControlHandle = OverwriteConfigurationControlHandle;

    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 {
        OverwriteConfigurationControlHandle { 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 OverwriteConfigurationRequestStream {
    type Item = Result<OverwriteConfigurationRequest, 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 OverwriteConfigurationRequestStream 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 {
                0x756a2a36396e0e08 => {
                    header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
                    let mut req = fidl::new_empty!(OverwriteConfigurationSetRequest, fidl::encoding::DefaultFuchsiaResourceDialect);
                    fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<OverwriteConfigurationSetRequest>(&header, _body_bytes, handles, &mut req)?;
                    let control_handle = OverwriteConfigurationControlHandle {
                        inner: this.inner.clone(),
                    };
                    Ok(OverwriteConfigurationRequest::Set {overwrite_format: req.overwrite_format,

                        responder: OverwriteConfigurationSetResponder {
                            control_handle: std::mem::ManuallyDrop::new(control_handle),
                            tx_id: header.tx_id,
                        },
                    })
                }
                _ if header.tx_id == 0 && header.dynamic_flags().contains(fidl::encoding::DynamicFlags::FLEXIBLE) => {
                    Ok(OverwriteConfigurationRequest::_UnknownMethod {
                        ordinal: header.ordinal,
                        control_handle: OverwriteConfigurationControlHandle { inner: this.inner.clone() },
                        method_type: fidl::MethodType::OneWay,
                    })
                }
                _ if header.dynamic_flags().contains(fidl::encoding::DynamicFlags::FLEXIBLE) => {
                    this.inner.send_framework_err(
                        fidl::encoding::FrameworkErr::UnknownMethod,
                        header.tx_id,
                        header.ordinal,
                        header.dynamic_flags(),
                        (bytes, handles),
                    )?;
                    Ok(OverwriteConfigurationRequest::_UnknownMethod {
                        ordinal: header.ordinal,
                        control_handle: OverwriteConfigurationControlHandle { inner: this.inner.clone() },
                        method_type: fidl::MethodType::TwoWay,
                    })
                }
                _ => Err(fidl::Error::UnknownOrdinal {
                    ordinal: header.ordinal,
                    protocol_name: <OverwriteConfigurationMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
                }),
            }))
            },
        )
    }
}

/// Provides control of the blobfs overwrite configuration to the product, which
/// controls how it reponds to `fuchsia.fxfs.BlobCreator.NeedsOverwrite`
/// during updates and what format all writes will use.
#[derive(Debug)]
pub enum OverwriteConfigurationRequest {
    /// Set the current configuration.
    Set { overwrite_format: OverwriteFormat, responder: OverwriteConfigurationSetResponder },
    /// An interaction was received which does not match any known method.
    #[non_exhaustive]
    _UnknownMethod {
        /// Ordinal of the method that was called.
        ordinal: u64,
        control_handle: OverwriteConfigurationControlHandle,
        method_type: fidl::MethodType,
    },
}

impl OverwriteConfigurationRequest {
    #[allow(irrefutable_let_patterns)]
    pub fn into_set(self) -> Option<(OverwriteFormat, OverwriteConfigurationSetResponder)> {
        if let OverwriteConfigurationRequest::Set { overwrite_format, responder } = self {
            Some((overwrite_format, responder))
        } else {
            None
        }
    }

    /// Name of the method defined in FIDL
    pub fn method_name(&self) -> &'static str {
        match *self {
            OverwriteConfigurationRequest::Set { .. } => "set",
            OverwriteConfigurationRequest::_UnknownMethod {
                method_type: fidl::MethodType::OneWay,
                ..
            } => "unknown one-way method",
            OverwriteConfigurationRequest::_UnknownMethod {
                method_type: fidl::MethodType::TwoWay,
                ..
            } => "unknown two-way method",
        }
    }
}

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

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

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

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

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

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

mod internal {
    use super::*;
}