fidl_fuchsia_accessibility_scene/

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

#[derive(Debug, PartialEq)]
pub struct ProviderCreateViewRequest {
    pub a11y_view_token: fidl_fuchsia_ui_views::ViewCreationToken,
    pub proxy_viewport_token: fidl_fuchsia_ui_views::ViewportCreationToken,
}

impl fidl::Standalone<fidl::encoding::DefaultFuchsiaResourceDialect> for ProviderCreateViewRequest {}

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

impl fidl::endpoints::ProtocolMarker for ProviderMarker {
    type Proxy = ProviderProxy;
    type RequestStream = ProviderRequestStream;
    #[cfg(target_os = "fuchsia")]
    type SynchronousProxy = ProviderSynchronousProxy;

    const DEBUG_NAME: &'static str = "fuchsia.accessibility.scene.Provider";
}
impl fidl::endpoints::DiscoverableProtocolMarker for ProviderMarker {}

pub trait ProviderProxyInterface: Send + Sync {
    fn r#create_view(
        &self,
        a11y_view_token: fidl_fuchsia_ui_views::ViewCreationToken,
        proxy_viewport_token: fidl_fuchsia_ui_views::ViewportCreationToken,
    ) -> Result<(), fidl::Error>;
}
#[derive(Debug)]
#[cfg(target_os = "fuchsia")]
pub struct ProviderSynchronousProxy {
    client: fidl::client::sync::Client,
}

#[cfg(target_os = "fuchsia")]
impl fidl::endpoints::SynchronousProxy for ProviderSynchronousProxy {
    type Proxy = ProviderProxy;
    type Protocol = ProviderMarker;

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

    /// Prompts the server (a11y manager) to create a new accessibility `View`,
    /// which the client (scene manager) must connect to the root of the scene
    /// graph.
    ///
    /// The accessibility view is used to vend capabilities to a11y manager
    /// that a view confers, e.g. ability to request focus, consume and
    /// respond to input events, annotate underlying views, and apply
    /// coordinate transforms to its subtree.
    ///
    /// With the a11y view, the scene topology is roughly:
    ///
    ///          scene root (owned by scene manager)
    ///               |
    ///         a11y viewport (owned by scene manager)
    ///               |
    ///           a11y view (owned by a11y manager)
    ///               |
    ///        proxy viewport (owned by a11y manager)
    ///               |
    ///          proxy view (owned by scene manager)
    ///               |
    ///        client viewport (owned by scene manager)
    ///               |
    ///          client view (owned by UI client)
    ///
    /// ARGS
    ///
    /// a11y_view_token: Token generated by scene manager, which a11y manager
    /// uses to create the a11y view in its flatland instance.
    ///
    /// proxy_viewport_token: Token generated by scene manager, which a11y manager
    /// uses to create a "proxy viewport" within the a11y view. The client must
    /// subsequently create a "proxy view" using the corresponding view creation
    /// token it generated.
    ///
    /// SYNCHRONIZATION
    ///
    /// Callers may safely proceed once the accessibility `ViewRef` is returned
    /// to the accessibility `ViewPort` holder.
    ///
    /// LIFECYCLE
    ///
    /// The client is free to close the channel any time after calling CreateView().
    ///
    /// EPITAPH
    ///
    /// This method may return the following epitaphs:
    ///
    /// - ZX_ERR_INVALID_ARGS, if either of the provided tokens is invalid.
    /// - ZX_ERR_PEER_CLOSED, if Scenic fails creating the accessibility `Viewport`.
    pub fn r#create_view(
        &self,
        mut a11y_view_token: fidl_fuchsia_ui_views::ViewCreationToken,
        mut proxy_viewport_token: fidl_fuchsia_ui_views::ViewportCreationToken,
    ) -> Result<(), fidl::Error> {
        self.client.send::<ProviderCreateViewRequest>(
            (&mut a11y_view_token, &mut proxy_viewport_token),
            0x406435c9e8281daf,
            fidl::encoding::DynamicFlags::empty(),
        )
    }
}

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

impl fidl::endpoints::Proxy for ProviderProxy {
    type Protocol = ProviderMarker;

    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 ProviderProxy {
    /// Create a new Proxy for fuchsia.accessibility.scene/Provider.
    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
        let protocol_name = <ProviderMarker 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) -> ProviderEventStream {
        ProviderEventStream { event_receiver: self.client.take_event_receiver() }
    }

    /// Prompts the server (a11y manager) to create a new accessibility `View`,
    /// which the client (scene manager) must connect to the root of the scene
    /// graph.
    ///
    /// The accessibility view is used to vend capabilities to a11y manager
    /// that a view confers, e.g. ability to request focus, consume and
    /// respond to input events, annotate underlying views, and apply
    /// coordinate transforms to its subtree.
    ///
    /// With the a11y view, the scene topology is roughly:
    ///
    ///          scene root (owned by scene manager)
    ///               |
    ///         a11y viewport (owned by scene manager)
    ///               |
    ///           a11y view (owned by a11y manager)
    ///               |
    ///        proxy viewport (owned by a11y manager)
    ///               |
    ///          proxy view (owned by scene manager)
    ///               |
    ///        client viewport (owned by scene manager)
    ///               |
    ///          client view (owned by UI client)
    ///
    /// ARGS
    ///
    /// a11y_view_token: Token generated by scene manager, which a11y manager
    /// uses to create the a11y view in its flatland instance.
    ///
    /// proxy_viewport_token: Token generated by scene manager, which a11y manager
    /// uses to create a "proxy viewport" within the a11y view. The client must
    /// subsequently create a "proxy view" using the corresponding view creation
    /// token it generated.
    ///
    /// SYNCHRONIZATION
    ///
    /// Callers may safely proceed once the accessibility `ViewRef` is returned
    /// to the accessibility `ViewPort` holder.
    ///
    /// LIFECYCLE
    ///
    /// The client is free to close the channel any time after calling CreateView().
    ///
    /// EPITAPH
    ///
    /// This method may return the following epitaphs:
    ///
    /// - ZX_ERR_INVALID_ARGS, if either of the provided tokens is invalid.
    /// - ZX_ERR_PEER_CLOSED, if Scenic fails creating the accessibility `Viewport`.
    pub fn r#create_view(
        &self,
        mut a11y_view_token: fidl_fuchsia_ui_views::ViewCreationToken,
        mut proxy_viewport_token: fidl_fuchsia_ui_views::ViewportCreationToken,
    ) -> Result<(), fidl::Error> {
        ProviderProxyInterface::r#create_view(self, a11y_view_token, proxy_viewport_token)
    }
}

impl ProviderProxyInterface for ProviderProxy {
    fn r#create_view(
        &self,
        mut a11y_view_token: fidl_fuchsia_ui_views::ViewCreationToken,
        mut proxy_viewport_token: fidl_fuchsia_ui_views::ViewportCreationToken,
    ) -> Result<(), fidl::Error> {
        self.client.send::<ProviderCreateViewRequest>(
            (&mut a11y_view_token, &mut proxy_viewport_token),
            0x406435c9e8281daf,
            fidl::encoding::DynamicFlags::empty(),
        )
    }
}

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

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

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

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

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

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

/// A Stream of incoming requests for fuchsia.accessibility.scene/Provider.
pub struct ProviderRequestStream {
    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
    is_terminated: bool,
}

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

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

impl fidl::endpoints::RequestStream for ProviderRequestStream {
    type Protocol = ProviderMarker;
    type ControlHandle = ProviderControlHandle;

    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 {
        ProviderControlHandle { 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 ProviderRequestStream {
    type Item = Result<ProviderRequest, 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 ProviderRequestStream 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 {
                    0x406435c9e8281daf => {
                        header.validate_request_tx_id(fidl::MethodType::OneWay)?;
                        let mut req = fidl::new_empty!(
                            ProviderCreateViewRequest,
                            fidl::encoding::DefaultFuchsiaResourceDialect
                        );
                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<ProviderCreateViewRequest>(&header, _body_bytes, handles, &mut req)?;
                        let control_handle = ProviderControlHandle { inner: this.inner.clone() };
                        Ok(ProviderRequest::CreateView {
                            a11y_view_token: req.a11y_view_token,
                            proxy_viewport_token: req.proxy_viewport_token,

                            control_handle,
                        })
                    }
                    _ => Err(fidl::Error::UnknownOrdinal {
                        ordinal: header.ordinal,
                        protocol_name:
                            <ProviderMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
                    }),
                }))
            },
        )
    }
}

#[derive(Debug)]
pub enum ProviderRequest {
    /// Prompts the server (a11y manager) to create a new accessibility `View`,
    /// which the client (scene manager) must connect to the root of the scene
    /// graph.
    ///
    /// The accessibility view is used to vend capabilities to a11y manager
    /// that a view confers, e.g. ability to request focus, consume and
    /// respond to input events, annotate underlying views, and apply
    /// coordinate transforms to its subtree.
    ///
    /// With the a11y view, the scene topology is roughly:
    ///
    ///          scene root (owned by scene manager)
    ///               |
    ///         a11y viewport (owned by scene manager)
    ///               |
    ///           a11y view (owned by a11y manager)
    ///               |
    ///        proxy viewport (owned by a11y manager)
    ///               |
    ///          proxy view (owned by scene manager)
    ///               |
    ///        client viewport (owned by scene manager)
    ///               |
    ///          client view (owned by UI client)
    ///
    /// ARGS
    ///
    /// a11y_view_token: Token generated by scene manager, which a11y manager
    /// uses to create the a11y view in its flatland instance.
    ///
    /// proxy_viewport_token: Token generated by scene manager, which a11y manager
    /// uses to create a "proxy viewport" within the a11y view. The client must
    /// subsequently create a "proxy view" using the corresponding view creation
    /// token it generated.
    ///
    /// SYNCHRONIZATION
    ///
    /// Callers may safely proceed once the accessibility `ViewRef` is returned
    /// to the accessibility `ViewPort` holder.
    ///
    /// LIFECYCLE
    ///
    /// The client is free to close the channel any time after calling CreateView().
    ///
    /// EPITAPH
    ///
    /// This method may return the following epitaphs:
    ///
    /// - ZX_ERR_INVALID_ARGS, if either of the provided tokens is invalid.
    /// - ZX_ERR_PEER_CLOSED, if Scenic fails creating the accessibility `Viewport`.
    CreateView {
        a11y_view_token: fidl_fuchsia_ui_views::ViewCreationToken,
        proxy_viewport_token: fidl_fuchsia_ui_views::ViewportCreationToken,
        control_handle: ProviderControlHandle,
    },
}

impl ProviderRequest {
    #[allow(irrefutable_let_patterns)]
    pub fn into_create_view(
        self,
    ) -> Option<(
        fidl_fuchsia_ui_views::ViewCreationToken,
        fidl_fuchsia_ui_views::ViewportCreationToken,
        ProviderControlHandle,
    )> {
        if let ProviderRequest::CreateView {
            a11y_view_token,
            proxy_viewport_token,
            control_handle,
        } = self
        {
            Some((a11y_view_token, proxy_viewport_token, control_handle))
        } else {
            None
        }
    }

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

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

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

mod internal {
    use super::*;

    impl fidl::encoding::ResourceTypeMarker for ProviderCreateViewRequest {
        type Borrowed<'a> = &'a mut Self;
        fn take_or_borrow<'a>(
            value: &'a mut <Self as fidl::encoding::TypeMarker>::Owned,
        ) -> Self::Borrowed<'a> {
            value
        }
    }

    unsafe impl fidl::encoding::TypeMarker for ProviderCreateViewRequest {
        type Owned = Self;

        #[inline(always)]
        fn inline_align(_context: fidl::encoding::Context) -> usize {
            4
        }

        #[inline(always)]
        fn inline_size(_context: fidl::encoding::Context) -> usize {
            8
        }
    }

    unsafe impl
        fidl::encoding::Encode<
            ProviderCreateViewRequest,
            fidl::encoding::DefaultFuchsiaResourceDialect,
        > for &mut ProviderCreateViewRequest
    {
        #[inline]
        unsafe fn encode(
            self,
            encoder: &mut fidl::encoding::Encoder<
                '_,
                fidl::encoding::DefaultFuchsiaResourceDialect,
            >,
            offset: usize,
            _depth: fidl::encoding::Depth,
        ) -> fidl::Result<()> {
            encoder.debug_check_bounds::<ProviderCreateViewRequest>(offset);
            // Delegate to tuple encoding.
            fidl::encoding::Encode::<ProviderCreateViewRequest, fidl::encoding::DefaultFuchsiaResourceDialect>::encode(
                (
                    <fidl_fuchsia_ui_views::ViewCreationToken as fidl::encoding::ResourceTypeMarker>::take_or_borrow(&mut self.a11y_view_token),
                    <fidl_fuchsia_ui_views::ViewportCreationToken as fidl::encoding::ResourceTypeMarker>::take_or_borrow(&mut self.proxy_viewport_token),
                ),
                encoder, offset, _depth
            )
        }
    }
    unsafe impl<
            T0: fidl::encoding::Encode<
                fidl_fuchsia_ui_views::ViewCreationToken,
                fidl::encoding::DefaultFuchsiaResourceDialect,
            >,
            T1: fidl::encoding::Encode<
                fidl_fuchsia_ui_views::ViewportCreationToken,
                fidl::encoding::DefaultFuchsiaResourceDialect,
            >,
        >
        fidl::encoding::Encode<
            ProviderCreateViewRequest,
            fidl::encoding::DefaultFuchsiaResourceDialect,
        > for (T0, T1)
    {
        #[inline]
        unsafe fn encode(
            self,
            encoder: &mut fidl::encoding::Encoder<
                '_,
                fidl::encoding::DefaultFuchsiaResourceDialect,
            >,
            offset: usize,
            depth: fidl::encoding::Depth,
        ) -> fidl::Result<()> {
            encoder.debug_check_bounds::<ProviderCreateViewRequest>(offset);
            // Zero out padding regions. There's no need to apply masks
            // because the unmasked parts will be overwritten by fields.
            // Write the fields.
            self.0.encode(encoder, offset + 0, depth)?;
            self.1.encode(encoder, offset + 4, depth)?;
            Ok(())
        }
    }

    impl fidl::encoding::Decode<Self, fidl::encoding::DefaultFuchsiaResourceDialect>
        for ProviderCreateViewRequest
    {
        #[inline(always)]
        fn new_empty() -> Self {
            Self {
                a11y_view_token: fidl::new_empty!(
                    fidl_fuchsia_ui_views::ViewCreationToken,
                    fidl::encoding::DefaultFuchsiaResourceDialect
                ),
                proxy_viewport_token: fidl::new_empty!(
                    fidl_fuchsia_ui_views::ViewportCreationToken,
                    fidl::encoding::DefaultFuchsiaResourceDialect
                ),
            }
        }

        #[inline]
        unsafe fn decode(
            &mut self,
            decoder: &mut fidl::encoding::Decoder<
                '_,
                fidl::encoding::DefaultFuchsiaResourceDialect,
            >,
            offset: usize,
            _depth: fidl::encoding::Depth,
        ) -> fidl::Result<()> {
            decoder.debug_check_bounds::<Self>(offset);
            // Verify that padding bytes are zero.
            fidl::decode!(
                fidl_fuchsia_ui_views::ViewCreationToken,
                fidl::encoding::DefaultFuchsiaResourceDialect,
                &mut self.a11y_view_token,
                decoder,
                offset + 0,
                _depth
            )?;
            fidl::decode!(
                fidl_fuchsia_ui_views::ViewportCreationToken,
                fidl::encoding::DefaultFuchsiaResourceDialect,
                &mut self.proxy_viewport_token,
                decoder,
                offset + 4,
                _depth
            )?;
            Ok(())
        }
    }
}