Struct fidl_fuchsia_ui_views::ViewRefFocusedProxy

pub struct ViewRefFocusedProxy { /* private fields */ }

Implementations

impl ViewRefFocusedProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.ui.views/ViewRefFocused.

pub fn take_event_stream(&self) -> ViewRefFocusedEventStream

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

Panics

Panics if the event stream was already taken.

pub fn watch(&self) -> QueryResponseFut<FocusState>

Sets up a callback to fire when the implicit ViewRef has gained or lost focus. Typically, focus changes happen at a slow pace, such that every transition is captured by the callback. However, focus changes can happen rapidly, so the callback may “compress” focus change history into just the latest known focus state.

The callback reports the last focus change spanning the duration from its issuance to the previous callback’s issuance. The client may observe any of the following four transitions:

• true -> true: The ViewRef has lost focus at least once, and has gained focus by the time of callback issuance.
• true -> false: The ViewRef has lost focus at least once, and has lost focus by the time of callback issuance.
• false -> true: The ViewRef has gained focus at least once, and has gained focus by the time of callback issuance.
• false -> false: The ViewRef has gained focus at least once, and has lost focus by the time of callback issuance.

The client avoids “focus flapping” and always sees the latest state. Every callback issuance is meaningful, and the client should renegotiate focus-related services appropriately, such as IME.

Flow control: The caller is allowed at most one in-flight |Watch| call at at time: subsequent |Watch| calls must wait until the acknowledgment returns. Non-compliance results in channel closure.

Trait Implementations

impl Clone for ViewRefFocusedProxy

fn clone(&self) -> ViewRefFocusedProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewRefFocusedProxy

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

Formats the value using the given formatter.

impl Proxy for ViewRefFocusedProxy

type Protocol = ViewRefFocusedMarker

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 ViewRefFocusedProxyInterface for ViewRefFocusedProxy

type WatchResponseFut = QueryResponseFut<FocusState>

fn watch(&self) -> Self::WatchResponseFut