Struct TapHold

pub struct TapHold<K: TapHoldNestable>(pub K);

Newtype for TapHoldNestable keys so they can implement key::Key for TapHoldPressedKey.

Tuple Fields

0: K

Implementations

impl<K: TapHoldNestable> TapHold<K>

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

Constructs a ‘fat’ key value from the given tap hold key.

impl TapHold<Key>

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

Constructs a TapHold newtype from the given key.

impl TapHold<ModifierKey>

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

Constructs a TapHold newtypefrom the given key.

impl TapHold<BaseKey>

pub const fn base_key(key: BaseKey) -> Self

Constructs a TapHold newtype from the given key.

Trait Implementations

impl<K: Clone + TapHoldNestable> Clone for TapHold<K>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + TapHoldNestable> Debug for TapHold<K>

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

Formats the value using the given formatter.

impl<K: TapHoldNestable> Key for TapHold<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: TapHoldNestable> LayeredNestable for TapHold<K>

fn as_fat_key(self) -> TapHoldKey<BaseKey>

Construct a ‘full representation’ of the nestable key.

impl<K: PartialEq + TapHoldNestable> PartialEq for TapHold<K>

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

impl<K: TapHoldNestable> StructuralPartialEq for TapHold<K>