Enum ChordedKey

pub enum ChordedKey<K: ChordedNestable> {
    Chorded(Key<K>),
    Auxiliary(AuxiliaryKey<K>),
    Pass(K),
}

An aggregate of key::Key types.

Variants

Chorded(Key<K>)

A chorded key.

Auxiliary(AuxiliaryKey<K>)

A chorded key.

Pass(K)

Non-chorded,

Implementations

impl<K: ChordedNestable> ChordedKey<K>

pub fn as_fat_key(self) -> ChordedKey<LayeredKey<TapHoldKey<BaseKey>>>

Constructs a ‘fat’ key value from the given chorded key.

impl ChordedKey<LayeredKey<TapHoldKey<BaseKey>>>

pub const fn keyboard(key: Key) -> Self

Constructs a [Key] from the given key::keyboard::Key.

pub const fn tap_hold(key: Key<BaseKey>) -> Self

Constructs a [Key] from the given key::tap_hold::Key.

pub const fn layer_modifier(key: ModifierKey) -> Self

Constructs a [Key] from the given key::layered::ModifierKey.

impl<K: LayeredNestable> ChordedKey<LayeredKey<K>>

pub const fn layered(key: LayeredKey<K>) -> Self

Constructs a [Key] from the given key::layered::LayeredKey.

Trait Implementations

impl<K: Clone + ChordedNestable> Clone for ChordedKey<K>

fn clone(&self) -> ChordedKey<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + ChordedNestable> Debug for ChordedKey<K>

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

Formats the value using the given formatter.

impl<'de, K> Deserialize<'de> for ChordedKey<K>

where K: Deserialize<'de> + ChordedNestable,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K: ChordedNestable> Key for ChordedKey<K>

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, and any active PressedKeys.

type PressedKey = PressedKey<ChordedKey<LayeredKey<TapHoldKey<BaseKey>>>, ChordedPressedKeyState<LayeredKey<TapHoldKey<BaseKey>>>>

The associated PressedKeyState implements functionality for the pressed key. (e.g. tap_hold::PressedKeyState implements behaviour resolving the pressed tap hold key as either ‘tap’ or ‘hold’).

fn new_pressed_key( &self, context: Self::Context, keymap_index: u16, ) -> (Self::PressedKey, PressedKeyEvents<Self::Event>)

Key::new_pressed_key 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).

impl<K: PartialEq + ChordedNestable> PartialEq for ChordedKey<K>

fn eq(&self, other: &ChordedKey<K>) -> 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: Copy + ChordedNestable> Copy for ChordedKey<K>

impl<K: ChordedNestable> StructuralPartialEq for ChordedKey<K>