Struct KeyboardListenerSynchronousProxy

pub struct KeyboardListenerSynchronousProxy { /* private fields */ }

Implementations

impl KeyboardListenerSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<KeyboardListenerEvent, 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 on_key_event( &self, event: &KeyEvent, ___deadline: MonotonicInstant, ) -> Result<KeyEventStatus, Error>

Called when a key event takes place, such as key press or release.

Protocol implementers must respond to acknowledge the event by returning Status in a timely manner, i.e. not introducing significant delays to the input pipeline (typically 10s of milliseconds).

Returning NOT_HANDLED means the event may be offered to other clients of other related APIs.

Clients that do not acknowledge their events will eventually be disconnected.

Notification is only dispatched to a view that has focus. No other views, including parents or children, will get notified specifically via OnKeyEvent.

Trait Implementations

impl Debug for KeyboardListenerSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for KeyboardListenerSynchronousProxy

type Proxy = KeyboardListenerProxy

The async proxy for the same protocol.

type Protocol = KeyboardListenerMarker

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.