Struct System

pub struct System<D: Keys> { /* private fields */ }

Aggregate key::System implementation.

Implementations

impl<const KEYBOARD: usize, const CALLBACK: usize, const STICKY: usize, const TAP_DANCE: usize, const TAP_HOLD: usize, const LAYER_MODIFIERS: usize, const LAYERED: usize, const CHORDED: usize, const CHORDED_AUXILIARY: usize> System<KeyArrays<KEYBOARD, CALLBACK, STICKY, TAP_DANCE, TAP_HOLD, LAYER_MODIFIERS, LAYERED, CHORDED, CHORDED_AUXILIARY>>

pub const fn array_based( keyboard: System<[Key; KEYBOARD]>, callback: System<[Key; CALLBACK]>, sticky: System<[Key; STICKY]>, tap_dance: System<Ref, [Key<Ref>; TAP_DANCE]>, tap_hold: System<Ref, [Key<Ref>; TAP_HOLD]>, layered: System<Ref, [ModifierKey; LAYER_MODIFIERS], [LayeredKey<Ref>; LAYERED]>, chorded: System<Ref, [Key<Ref>; CHORDED], [AuxiliaryKey<Ref>; CHORDED_AUXILIARY]>, ) -> Self

Constructs a new System.

impl System<KeyVecs>

pub const fn vec_based( keyboard: System<<KeyVecs as Keys>::Keyboard>, callback: System<<KeyVecs as Keys>::Callback>, sticky: System<<KeyVecs as Keys>::Sticky>, tap_dance: System<Ref, <KeyVecs as Keys>::TapDance>, tap_hold: System<Ref, <KeyVecs as Keys>::TapHold>, layered: System<Ref, <KeyVecs as Keys>::LayerModifiers, <KeyVecs as Keys>::Layered>, chorded: System<Ref, <KeyVecs as Keys>::Chorded, <KeyVecs as Keys>::ChordedAuxiliary>, ) -> Self

Constructs a new System.

Trait Implementations

impl<D: Clone + Keys> Clone for System<D>

where D::Keyboard: Clone, D::Callback: Clone, D::Sticky: Clone, D::TapDance: Clone, D::TapHold: Clone, D::LayerModifiers: Clone, D::Layered: Clone, D::Chorded: Clone, D::ChordedAuxiliary: Clone,

fn clone(&self) -> System<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug + Keys> Debug for System<D>

where D::Keyboard: Debug, D::Callback: Debug, D::Sticky: Debug, D::TapDance: Debug, D::TapHold: Debug, D::LayerModifiers: Debug, D::Layered: Debug, D::Chorded: Debug, D::ChordedAuxiliary: Debug,

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

Formats the value using the given formatter.

impl<D: PartialEq + Keys> PartialEq for System<D>

where D::Keyboard: PartialEq, D::Callback: PartialEq, D::Sticky: PartialEq, D::TapDance: PartialEq, D::TapHold: PartialEq, D::LayerModifiers: PartialEq, D::Layered: PartialEq, D::Chorded: PartialEq, D::ChordedAuxiliary: PartialEq,

fn eq(&self, other: &System<D>) -> 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<K: Debug + Keys> System<Ref> for System<K>

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 schedules a tap_hold::Event::TapHoldTimeout so that holding the key resolves as a hold).

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.

impl<D: Copy + Keys> Copy for System<D>

where D::Keyboard: Copy, D::Callback: Copy, D::Sticky: Copy, D::TapDance: Copy, D::TapHold: Copy, D::LayerModifiers: Copy, D::Layered: Copy, D::Chorded: Copy, D::ChordedAuxiliary: Copy,

impl<D: Keys> StructuralPartialEq for System<D>