Struct Key

pub struct Key<K: Key> {
    pub tap: K,
    pub hold: K,
}

A key with tap-hold functionality.

Fields

tap: K

The ‘tap’ key.

hold: K

The ‘hold’ key.

Implementations

impl<K: Key> Key<K>

pub const fn new(tap: K, hold: K) -> Key<K>

Constructs a new tap-hold key.

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

Maps the Key of the Key into a new type.

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

where K: Into<T>,

Maps the Key of the Key into a new type.

impl<K: Key> Key<K>

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

Constructs a new pressed key state and a scheduled event for the tap-hold key.

Trait Implementations

impl<K: Clone + Key> 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 + Key> 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> + Key,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K: TapHoldNestable> From<Key<K>> for TapHoldKey<K>

fn from(key: Key<K>) -> Self

Converts to this type from the input type.

impl<K: TapHoldNestable> 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<TapHoldKey<BaseKey>, TapHoldPressedKeyState<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 + Key> 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 + Key> Copy for Key<K>

impl<K: Key> StructuralPartialEq for Key<K>