Struct keytokey::Keyboard

pub struct Keyboard<'a, T: USBKeyOut> {
    pub output: T,
    // some fields omitted
}

the main keyboard struct

add handlers wit add_handler, then call add_keypress/add_key_release/add_timeout to start processing keys.

Fields

output: T

Implementations

impl<'a, T: USBKeyOut> Keyboard<'a, T>

pub fn new(output: T) -> Keyboard<'a, T>

pub fn add_handler(
    &mut self,
    handler: Box<dyn ProcessKeys<T> + Send + 'a>
) -> HandlerID

add a handler, return a HandlerID which you may use with keyboard.output.state().enable_handler / disable_handler / toggle_handler / is_handler_enabled

by default, most handlers start in the enabled state (with the notable exception of Layers).

pub fn future_handler_id(&self, offset: usize) -> HandlerID

predict the next or further out hander_ids returned by add_handler Needed to add space cadets before the layers they toggle.

pub fn handle_keys(&mut self) -> Result<(), ()>

handle an update to the event stream

This returns OK(()) if all keys are handled by the handlers and an Err(()) otherwise. that way the down stream can decide what to do (tests: panic. Firmare/MatrixToStream -> drop unhandled events)

pub fn clear_unhandled(&mut self)

pub fn add_keypress<X: AcceptsKeycode>(
    &mut self,
    keycode: X,
    ms_since_last: u16
)

add a KeyPress event

pub fn add_keyrelease<X: AcceptsKeycode>(
    &mut self,
    keycode: X,
    ms_since_last: u16
)

add a KeyRelease event

pub fn add_timeout(&mut self, ms_since_last: u16)