Struct ViewRefFocusedSynchronousProxy

pub struct ViewRefFocusedSynchronousProxy { /* private fields */ }

Implementations

impl ViewRefFocusedSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ViewRefFocusedEvent, Error>

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 watch(&self, ___deadline: MonotonicInstant) -> Result<FocusState, Error>

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 Debug for ViewRefFocusedSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for ViewRefFocusedSynchronousProxy

type Proxy = ViewRefFocusedProxy

The async proxy for the same protocol.

type Protocol = ViewRefFocusedMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.