Struct KeyboardListenerProxy

pub struct KeyboardListenerProxy { /* private fields */ }

Implementations

impl KeyboardListenerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.ui.input3/KeyboardListener.

pub fn take_event_stream(&self) -> KeyboardListenerEventStream

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

Panics

Panics if the event stream was already taken.

pub fn on_key_event( &self, event: &KeyEvent, ) -> QueryResponseFut<KeyEventStatus, DefaultFuchsiaResourceDialect>

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 Clone for KeyboardListenerProxy

fn clone(&self) -> KeyboardListenerProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardListenerProxy

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

Formats the value using the given formatter.

impl KeyboardListenerProxyInterface for KeyboardListenerProxy

type OnKeyEventResponseFut = QueryResponseFut<KeyEventStatus>

fn on_key_event(&self, event: &KeyEvent) -> Self::OnKeyEventResponseFut

impl Proxy for KeyboardListenerProxy

type Protocol = KeyboardListenerMarker

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.