Struct System

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

Aggregate key::System implementation.

Implementations

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

pub const fn array_based( automation: AutomationSystem<[AutomationKey; AUTOMATION]>, callback: CallbackSystem<[CallbackKey; CALLBACK]>, chorded: ChordedSystem<[ChordedKey; CHORDED], [ChordedAuxiliaryKey; CHORDED_AUXILIARY]>, keyboard: KeyboardSystem<[KeyboardKey; KEYBOARD]>, layered: LayeredSystem<[LayeredModifierKey; LAYER_MODIFIERS], [LayeredKey; LAYERED]>, sticky: StickySystem<[StickyKey; STICKY]>, tap_dance: TapDanceSystem<[TapDanceKey; TAP_DANCE]>, tap_hold: TapHoldSystem<[TapHoldKey; TAP_HOLD]>, ) -> Self

Constructs a new System.

impl System<KeyVecs>

pub const fn vec_based( automation: AutomationSystem<Vec<AutomationKey>>, callback: CallbackSystem<Vec<CallbackKey>>, chorded: ChordedSystem<Vec<ChordedKey>, Vec<ChordedAuxiliaryKey>>, keyboard: KeyboardSystem<Vec<KeyboardKey>>, layered: LayeredSystem<Vec<LayeredModifierKey>, Vec<LayeredKey>>, sticky: StickySystem<Vec<StickyKey>>, tap_dance: TapDanceSystem<Vec<TapDanceKey>>, tap_hold: TapHoldSystem<Vec<TapHoldKey>>, ) -> Self

Constructs a new System.

Trait Implementations

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

where D::Automation: Clone, D::Callback: Clone, D::Chorded: Clone, D::ChordedAuxiliary: Clone, D::Keyboard: Clone, D::LayerModifiers: Clone, D::Layered: Clone, D::Sticky: Clone, D::TapDance: Clone, D::TapHold: 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::Automation: Debug, D::Callback: Debug, D::Chorded: Debug, D::ChordedAuxiliary: Debug, D::Keyboard: Debug, D::LayerModifiers: Debug, D::Layered: Debug, D::Sticky: Debug, D::TapDance: Debug, D::TapHold: 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::Automation: PartialEq, D::Callback: PartialEq, D::Chorded: PartialEq, D::ChordedAuxiliary: PartialEq, D::Keyboard: PartialEq, D::LayerModifiers: PartialEq, D::Layered: PartialEq, D::Sticky: PartialEq, D::TapDance: PartialEq, D::TapHold: 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::Automation: Copy, D::Callback: Copy, D::Chorded: Copy, D::ChordedAuxiliary: Copy, D::Keyboard: Copy, D::LayerModifiers: Copy, D::Layered: Copy, D::Sticky: Copy, D::TapDance: Copy, D::TapHold: Copy,

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