Struct pc_keyboard::Keyboard

pub struct Keyboard<L, S>
where
    S: ScancodeSet,
    L: KeyboardLayout,
{ /* private fields */ }

Encapsulates decode/sampling logic, and handles state transitions and key events.

Implementations

impl<L, S> Keyboard<L, S>

where L: KeyboardLayout, S: ScancodeSet,

pub const fn new( scancode_set: S, layout: L, handle_ctrl: HandleControl, ) -> Keyboard<L, S>

Make a new Keyboard object with the given layout.

pub const fn get_modifiers(&self) -> &Modifiers

Get the current key modifier states.

pub fn set_ctrl_handling(&mut self, new_value: HandleControl)

Change the Ctrl key mapping.

pub const fn get_ctrl_handling(&self) -> HandleControl

Get the current Ctrl key mapping.

pub fn clear(&mut self)

Clears the bit register.

Call this when there is a timeout reading data from the keyboard.

pub fn add_word(&mut self, word: u16) -> Result<Option<KeyEvent>, Error>

Processes a 16-bit word from the keyboard.

• The start bit (0) must be in bit 0.
• The data octet must be in bits 1..8, with the LSB in bit 1 and the MSB in bit 8.
• The parity bit must be in bit 9.
• The stop bit (1) must be in bit 10.

pub fn add_byte(&mut self, byte: u8) -> Result<Option<KeyEvent>, Error>

Processes an 8-bit byte from the keyboard.

We assume the start, stop and parity bits have been processed and verified.

pub fn add_bit(&mut self, bit: bool) -> Result<Option<KeyEvent>, Error>

Shift a bit into the register.

Call this /or/ call add_word - don’t call both. Until the last bit is added you get Ok(None) returned.

pub fn process_keyevent(&mut self, ev: KeyEvent) -> Option<DecodedKey>

Processes a KeyEvent returned from add_bit, add_byte or add_word and produces a decoded key.

For example, the KeyEvent for pressing the ‘5’ key on your keyboard gives a DecodedKey of unicode character ‘5’, unless the shift key is held in which case you get the unicode character ‘%’.

Trait Implementations

impl<L, S> Debug for Keyboard<L, S>

where S: ScancodeSet + Debug, L: KeyboardLayout + Debug,

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

Formats the value using the given formatter.