Struct Keymap

pub struct Keymap<Ctx, Ev: Debug, PKS, KS, I> { /* private fields */ }

State for a keymap that handles input, and outputs HID keyboard reports.

Implementations

impl<Ctx: Context<Event = Ev> + SetKeymapContext, Ev: Copy + Debug + PartialEq, PKS, KS, K: Key<Context = Ctx, Event = Ev, PendingKeyState = PKS, KeyState = KS> + ?Sized, I: Index<usize, Output = K>> Keymap<Ctx, Ev, PKS, KS, I>

where KS: From<NoOpKeyState<K::Context, K::Event>> + KeyState<Context = Ctx, Event = Ev> + Copy,

pub const fn new(key_definitions: I, context: Ctx) -> Self

Constructs a new keymap with the given key definitions and context.

pub fn init(&mut self)

Initializes or resets the keyboard to an initial state.

pub fn set_callback(&mut self, callback_id: KeymapCallback, callback_fn: fn())

Registers the given callback to the keymap.

Only one callback is set for each callback id.

pub fn set_callback_extern( &mut self, callback_id: KeymapCallback, callback_fn: extern "C" fn(), )

Registers the given callback to the keymap.

Only one callback is set for each callback id.

pub fn set_ms_per_tick(&mut self, ms_per_tick: u8)

Sets the number of ms per tick().

pub fn handle_input(&mut self, ev: Event)

Handles input events.

pub fn tick(&mut self)

Advances the state of the keymap by one tick.

pub fn pressed_keys(&self) -> Vec<KeyOutput, { MAX_PRESSED_KEYS }>

Returns the the pressed key outputs.

pub fn report_output(&mut self) -> KeymapOutput

Updates the keymap indicating a report is sent; returns the reportable keymap output.

Trait Implementations

impl<Ctx: Debug, Ev: Debug, PKS: Debug, KS: Debug, K: Key<Context = Ctx, Event = Ev, PendingKeyState = PKS, KeyState = KS> + ?Sized, I: Index<usize, Output = K>> Debug for Keymap<Ctx, Ev, PKS, KS, I>

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

Formats the value using the given formatter.