Struct System

pub struct System<R: Copy + Debug + PartialEq, Keys: Index<usize, Output = Key<R>>, AuxiliaryKeys: Index<usize, Output = AuxiliaryKey<R>>> { /* private fields */ }

The key::System implementation for the chorded key system.

Implementations

impl<R: Copy + Debug + PartialEq, Keys: Index<usize, Output = Key<R>>, AuxiliaryKeys: Index<usize, Output = AuxiliaryKey<R>>> System<R, Keys, AuxiliaryKeys>

pub const fn new(keys: Keys, auxiliary_keys: AuxiliaryKeys) -> Self

Constructs a new System with the given key data.

Trait Implementations

impl<R: Clone + Copy + Debug + PartialEq, Keys: Clone + Index<usize, Output = Key<R>>, AuxiliaryKeys: Clone + Index<usize, Output = AuxiliaryKey<R>>> Clone for System<R, Keys, AuxiliaryKeys>

fn clone(&self) -> System<R, Keys, AuxiliaryKeys>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug + Copy + Debug + PartialEq, Keys: Debug + Index<usize, Output = Key<R>>, AuxiliaryKeys: Debug + Index<usize, Output = AuxiliaryKey<R>>> Debug for System<R, Keys, AuxiliaryKeys>

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

Formats the value using the given formatter.

impl<R: PartialEq + Copy + Debug + PartialEq, Keys: PartialEq + Index<usize, Output = Key<R>>, AuxiliaryKeys: PartialEq + Index<usize, Output = AuxiliaryKey<R>>> PartialEq for System<R, Keys, AuxiliaryKeys>

fn eq(&self, other: &System<R, Keys, AuxiliaryKeys>) -> 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<R: Copy + Debug + PartialEq, Keys: Debug + Index<usize, Output = Key<R>>, AuxiliaryKeys: Debug + Index<usize, Output = AuxiliaryKey<R>>> System<R> for System<R, Keys, AuxiliaryKeys>

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<R, 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<R>>, 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<R: Copy + Copy + Debug + PartialEq, Keys: Copy + Index<usize, Output = Key<R>>, AuxiliaryKeys: Copy + Index<usize, Output = AuxiliaryKey<R>>> Copy for System<R, Keys, AuxiliaryKeys>

impl<R: Copy + Debug + PartialEq, Keys: Index<usize, Output = Key<R>>, AuxiliaryKeys: Index<usize, Output = AuxiliaryKey<R>>> StructuralPartialEq for System<R, Keys, AuxiliaryKeys>