Struct ControllerProxy

pub struct ControllerProxy { /* private fields */ }

Implementations

impl ControllerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.ui.test.scene/Controller.

pub fn take_event_stream(&self) -> ControllerEventStream

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

Panics

Panics if the event stream was already taken.

pub fn attach_client_view( &self, payload: ControllerAttachClientViewRequest, ) -> QueryResponseFut<u64, DefaultFuchsiaResourceDialect>

*** NOTE: ViewProvider is no longer the preferred way for a parent and child view to agree on a ViewportCreationToken / ViewCreationToken pair. Flatland-based clients are encouraged to use PresentView (below) instead of AttachClientView.

Elicits the server to request a view using the fuchsia.ui.app.ViewProvider handle provided, and attach it to the scene.

RETURN VALUE

This method returns the KOID for the client view’s ViewRef.

SYNCHRONIZATION

This call returns as soon as the client ViewRef is available. Note that this signal does NOT necessarily indicate that the view has been attached to the scene.

LIFE CYCLE

Clients may drop the Controller connection once AttachClientView has returned.

pub fn present_client_view( &self, payload: ControllerPresentClientViewRequest, ) -> Result<(), Error>

Elicits the server to create a viewport using viewport_creation_token.

LIFE CYCLE

Clients may drop the Controller connection once PresentClientView has returned.

pub fn register_view_tree_watcher( &self, watcher: ServerEnd<ViewTreeWatcherMarker>, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Registers a ViewTreeWatcher on the client’s behalf.

The ViewTreeWatcher registered on behalf of the client will currently be scoped globally; we intend to restrict the scope to the client view’s subtree as soon as it’s feasible to do so.

For more information on geometry observation, see the documentation in //sdk/fidl/fuchsia.ui.observation.geometry/watcher.fidl.

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

A hanging get to watch for updates to view presentation.

Callers can use this method to wait until a ClientView has Present()-ed through any of the following view presentation methods:

• fuchsia.ui.test.scene.Controller/AttachClientView()
• fuchsia.ui.test.scene.Controller/PresentClientView()
• fuchsia.element.GraphicalPresenter/PresentView()

Callers should expect to call this method once for each view they expect to wait for.

Note that callers must take care when interleaving calls, since this method has no way to a) associate a Present() with a specific ClientView, or b) associate a Present() with an AttachClientView() call, rather than a PresentClientView() or PresentView call.

It is invalid to call WatchViewPresentation while a previous call is still pending; subsequent requests will be ignored.

Trait Implementations

impl Clone for ControllerProxy

fn clone(&self) -> ControllerProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ControllerProxyInterface for ControllerProxy

type AttachClientViewResponseFut = QueryResponseFut<u64>

type RegisterViewTreeWatcherResponseFut = QueryResponseFut<()>

type WatchViewPresentationResponseFut = QueryResponseFut<()>

fn attach_client_view( &self, payload: ControllerAttachClientViewRequest, ) -> Self::AttachClientViewResponseFut

fn present_client_view( &self, payload: ControllerPresentClientViewRequest, ) -> Result<(), Error>

fn register_view_tree_watcher( &self, watcher: ServerEnd<ViewTreeWatcherMarker>, ) -> Self::RegisterViewTreeWatcherResponseFut

fn watch_view_presentation(&self) -> Self::WatchViewPresentationResponseFut

impl Debug for ControllerProxy

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

Formats the value using the given formatter.

impl Proxy for ControllerProxy

type Protocol = ControllerMarker

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.