Struct Key

pub struct Key<K> { /* private fields */ }

Primary Chorded key (with a passthrough key).

The primary key is the key with the lowest index in the chord, and has the key used for the resolved chord.

Implementations

impl<K: Key + Copy> Key<K>

where K::Context: Into<Context>, K::Event: TryInto<Event> + From<Event>,

pub const fn new(chord: K, passthrough: K) -> Self

Constructs new chorded key.

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

Constructs new pressed key.

pub fn map_key<T: Key + Copy>(self, f: fn(_: K) -> T) -> Key<T>

Maps the Key of the Key into a new type.

pub fn into_key<T: Key + Copy>(self) -> Key<T>

where K: Into<T>,

Maps the Key of the Key into a new type.

Trait Implementations

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

fn passthrough_key(&self) -> &K

The chorded key’s “passthrough” key.

fn chorded_key(&self) -> Option<&K>

The chorded key’s “chorded” key.

impl<K: Clone> Clone for Key<K>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for Key<K>

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

Formats the value using the given formatter.

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

where K: Deserialize<'de>,

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 Key<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> PartialEq for Key<K>

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

impl<K> StructuralPartialEq for Key<K>