Struct KeyboardBackend 

pub struct KeyboardBackend<I: Index<usize, Output = R> = [Ref; 1], R = Ref, Ctx = Context, Ev: Debug = Event, PKS = PendingKeyState, KS = KeyState, S = System> { /* private fields */ }

The keyboard “backend”, manages the keyboard from the events received (presses/releases of coordinates on a keyboard layout). through to listing HID scancodes to report using HIDs.

Type parameters match Keymap.

Implementations

impl KeyboardBackend

pub fn new() -> Self

Constructs a new keyboard backend using the board keymap ([smart_keymap::new_keymap]).

impl<I, R, Ctx, Ev, PKS, KS, S> KeyboardBackend<I, R, Ctx, Ev, PKS, KS, S>

where I: Index<usize, Output = R>, Ev: Debug,

pub fn new_with_keymap(keymap: Keymap<I, R, Ctx, Ev, PKS, KS, S>) -> Self

Constructs a new keyboard backend with the given keymap.

impl<I, R, Ctx, Ev, PKS, KS, S> KeyboardBackend<I, R, Ctx, Ev, PKS, KS, S>

where I: Debug + Index<usize, Output = R>, R: Copy + Debug, Ctx: Debug + Context<Event = Ev> + SetKeymapContext, Ev: Copy + Debug, PKS: Debug, KS: Copy + Debug + From<NoOpKeyState>, S: System<R, Ref = R, Context = Ctx, Event = Ev, PendingKeyState = PKS, KeyState = KS>,

pub fn set_callbacks(&mut self, callbacks: KeymapCallbacks)

Set the keymap callbacks.

pub fn event(&mut self, event: Event)

Register a key event.

pub fn tick(&mut self) -> bool

A time event.

This method must be called regularly, typically every millisecond.

Returns true if the pressed_key_codes have changed.

pub fn keymap_output(&self) -> &KeymapOutput

Returns the current keymap output.

Trait Implementations

impl<I: Debug + Index<usize, Output = R>, R: Debug, Ctx: Debug, Ev: Debug + Debug, PKS: Debug, KS: Debug, S: Debug> Debug for KeyboardBackend<I, R, Ctx, Ev, PKS, KS, S>

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

Formats the value using the given formatter.

impl Default for KeyboardBackend

fn default() -> Self

Returns the “default value” for a type.