Struct kernel::services::keyboard::KeyClient

pub struct KeyClient {
    rx: KConsumer<KeyEvent>,
}

A client that receives KeyEvents from a KeyboardService.

Fields

rx: KConsumer<KeyEvent>

Implementations

impl KeyClient

pub async fn from_registry( kernel: &'static Kernel, subscribe: Subscribe, ) -> Result<Self, FromRegistryError>

Obtain a KeyClient

If the KeyboardService hasn’t been registered yet, we will retry until it has been registered.

pub async fn from_registry_no_retry( kernel: &'static Kernel, subscribe: Subscribe, ) -> Result<Self, FromRegistryError>

Obtain an KeyClient

Does NOT attempt to get an KeyboardService handle more than once.

Prefer KeyClient::from_registry unless you will not be spawning one around the same time as obtaining a client.

async fn from_handle( subscribe: Subscribe, handle: KernelHandle<KeyboardService>, ) -> Result<Self, FromRegistryError>

pub async fn next(&mut self) -> Result<KeyEvent, KeyClientError>

Returns the next KeyEvent received from the KeyboardService.

Returns

• Ok(KeyEvent) when a keyboard event is received.
• Err(KeyClientError) if the KeyboardService is no longer available.

pub async fn next_char(&mut self) -> Result<char, KeyClientError>

Returns the next Unicode char received from the KeyboardService.

Any KeyEvents which are not Unicode chars are skipped. This method is equivalent to calling KeyEvent::into_char on the KeyEvent returned by KeyClient::next.

Returns

• Ok(char) if a keyboard event is received and the keyboard event corresponds to a Unicode char
• Err(KeyClientError) if the KeyboardService is no longer available.