Enum Ref

pub enum Ref {
    Keyboard(Ref),
    CapsWord(Ref),
    Callback(Ref),
    Sticky(Ref),
    Custom(Ref),
    TapDance(Ref),
    TapHold(Ref),
    Layered(Ref),
    Chorded(Ref),
}

Aggregate enum for key references.

Variants

Keyboard(Ref)

key::keyboard::Ref variant.

CapsWord(Ref)

key::caps_word::Ref variant.

Callback(Ref)

key::callback::Ref variant.

Sticky(Ref)

key::sticky::Ref variant.

Custom(Ref)

key::custom::Ref variant.

TapDance(Ref)

key::tap_dance::Ref variant.

TapHold(Ref)

key::tap_hold::Ref variant.

Layered(Ref)

key::layered::Ref variant.

Chorded(Ref)

key::chorded::Ref variant.

Trait Implementations

impl Clone for Ref

fn clone(&self) -> Ref

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ref

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

Formats the value using the given formatter.

impl Default for Ref

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Ref

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Ref

fn eq(&self, other: &Ref) -> 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 Copy for Ref

impl StructuralPartialEq for Ref