Module key

Smart key interface and implementations.

The core interface for the smart keymap library is key::Key, and its associated key::Context and key::PressedKeyState types. Together, these are used to define smart key behaviour.

Modules

• chorded
  Chorded keys. (Chording functionality).
• composite
  “Composite” keys; an aggregate type used for a common context and event. This module implements the keymap::Key for a ‘composite’ key, which can be any of the other key definitions, and is the default Key for the keymap::KeyMap implementation.
• keyboard
  HID Keyboard keys.
• layered
  Layered keys. (Layering functionality).
• tap_hold
  Tap-Hold keys.

Structs

• KeyOutput
  Struct for the output from PressedKey.
• KeyboardModifiers
  Bool flags for each of the modifier keys (left ctrl, etc.).
• PressedKeyEvents
  Events emitted when a Key is pressed.
• ScheduledEvent
  Schedules a given T with Event, for some Schedule.

Enums

• Event
  Events which are either input, or for a particular Key::Event.
• EventError
  Errors for TryFrom implementations.
• KeyOutputState
  Whether the key output is pending or resolved.
• Schedule
  Schedule for a ScheduledEvent.

Constants

• MAX_KEY_EVENTS
  The maximum number of key events that are emitted Key or PressedKeyState.

Traits

• Context
  Used to provide state that may affect behaviour when pressing the key.
• Key
  The interface for Key behaviour.
• PressedKey
  PressedKeyState for a stateful pressed key value.
• PressedKeyState
  Implements functionality for the pressed key.