Struct System 

pub struct System { /* private fields */ }

Aggregate key::System for the default keyboard-only map.

Implementations

impl System

pub const fn new(keyboard: System<Ref, [Key; 0]>) -> Self

Constructs the system from the keyboard subsystem.

Trait Implementations

impl Clone for System

fn clone(&self) -> System

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for System

impl Debug for System

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

Formats the value using the given formatter.

impl PartialEq for System

fn eq(&self, other: &System) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for System

impl System<Ref> for System

type Ref = Ref

Used to identify the key definition in the keymap.

type Context = Context

The associated Context is used to provide state that may affect behaviour when pressing the key. (e.g. the behaviour of layered::LayeredKey depends on which layers are active in layered::Context).

type Event = Event

The associated Event is to be handled by the associated Context, pending key states, and key states.

type PendingKeyState = PendingKeyState

Associated pending key state.

type KeyState = KeyState

Associated key state type.

fn new_pressed_key( &self, keymap_index: u16, context: &Self::Context, key_ref: Ref, ) -> (PressedKeyResult<Ref, Self::PendingKeyState, Self::KeyState>, KeyEvents<Self::Event>)

Produces a pressed key value, and may yield some ScheduledEvents. (e.g. tap_hold::Key may schedule a tap_hold::Event::TapHoldTimeout so that holding the key resolves as a hold, when a timeout is configured).

fn update_pending_state( &self, pending_state: &mut Self::PendingKeyState, keymap_index: u16, context: &Self::Context, key_ref: Ref, event: Event<Self::Event>, ) -> (Option<NewPressedKey<Ref>>, KeyEvents<Self::Event>)

Update the given pending key state with the given impl.

fn update_state( &self, key_state: &mut Self::KeyState, key_ref: &Self::Ref, context: &Self::Context, keymap_index: u16, event: Event<Self::Event>, ) -> KeyEvents<Self::Event>

Used to update the KeyState’s state, and possibly yield event(s).

fn key_output( &self, key_ref: &Self::Ref, key_state: &Self::KeyState, ) -> Option<KeyOutput>

Output for the pressed key state.

fn pending_output( &self, _pending_key_state: &Self::PendingKeyState, ) -> Option<KeyOutput>

HID while a pending session is live.