Struct ScenicProxy

pub struct ScenicProxy { /* private fields */ }

Implementations

impl ScenicProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.ui.scenic/Scenic.

pub fn take_event_stream(&self) -> ScenicEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn create_session( &self, session: ServerEnd<SessionMarker>, listener: Option<ClientEnd<SessionListenerMarker>>, ) -> Result<(), Error>

Create a new Session, which is the primary way to interact with Scenic.

pub fn create_session2( &self, session: ServerEnd<SessionMarker>, listener: Option<ClientEnd<SessionListenerMarker>>, view_focuser: Option<ServerEnd<FocuserMarker>>, ) -> Result<(), Error>

Create a new Session, which is the primary way to interact with Scenic.

In this variant, the caller may register a request for focus management. The view_focuser’s client is coupled to the requested session, and this coupling acts as a security boundary: the ViewRef used as the basis for authority by view_focuser must come from session.

pub fn create_session_t( &self, endpoints: SessionEndpoints, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Create a new Session, which is the primary way to interact with Scenic.

In this variant, the caller may submit a combination of protocols that make sense for it. The Session protocol is the only required protocol. The SessionEndpoints table may be extended with more protocol fields, but these extensions should retain ABI and API compatibility with existing (pre-compiled) clients.

The response acknowledges the request to create a Session, but actual creation may happen later.

pub fn get_display_info( &self, ) -> QueryResponseFut<DisplayInfo, DefaultFuchsiaResourceDialect>

Get information about the Scenic’s primary display.

pub fn get_display_ownership_event( &self, ) -> QueryResponseFut<Event, DefaultFuchsiaResourceDialect>

Gets an event signaled with displayOwnedSignal or displayNotOwnedSignal when display ownership changes.

pub fn take_screenshot( &self, ) -> QueryResponseFut<(ScreenshotData, bool), DefaultFuchsiaResourceDialect>

Take a screenshot and return the data in img_data. img_data will not contain BGRA data if success is false.

pub fn uses_flatland( &self, ) -> QueryResponseFut<bool, DefaultFuchsiaResourceDialect>

Returns whether the clients should use [fuchsia.ui.composition/Flatland] protocol to interact with Scenic instead.

Trait Implementations

impl Clone for ScenicProxy

fn clone(&self) -> ScenicProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScenicProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Proxy for ScenicProxy

type Protocol = ScenicMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.

impl ScenicProxyInterface for ScenicProxy

type CreateSessionTResponseFut = QueryResponseFut<()>

type GetDisplayInfoResponseFut = QueryResponseFut<DisplayInfo>

type GetDisplayOwnershipEventResponseFut = QueryResponseFut<Event>

type TakeScreenshotResponseFut = QueryResponseFut<(ScreenshotData, bool)>

type UsesFlatlandResponseFut = QueryResponseFut<bool>

fn create_session( &self, session: ServerEnd<SessionMarker>, listener: Option<ClientEnd<SessionListenerMarker>>, ) -> Result<(), Error>

fn create_session2( &self, session: ServerEnd<SessionMarker>, listener: Option<ClientEnd<SessionListenerMarker>>, view_focuser: Option<ServerEnd<FocuserMarker>>, ) -> Result<(), Error>

fn create_session_t( &self, endpoints: SessionEndpoints, ) -> Self::CreateSessionTResponseFut

fn get_display_info(&self) -> Self::GetDisplayInfoResponseFut

fn get_display_ownership_event( &self, ) -> Self::GetDisplayOwnershipEventResponseFut

fn take_screenshot(&self) -> Self::TakeScreenshotResponseFut

fn uses_flatland(&self) -> Self::UsesFlatlandResponseFut