Struct Key

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

A key with tap-dance functionality.

Implementations

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

pub const fn new(definitions: [Option<K>; 3]) -> Key<K>

Constructs a new tap-dance key.

pub const fn from_definitions(defs: &[K]) -> Self

Construct the tap-dance key from the given slice of keys.

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: Key<Context = Context, Event = Event, PendingKeyState = PendingKeyState, KeyState = KeyState>> 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, 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, context: &Self::Context, key_path: KeyPath, ) -> (PressedKeyResult<Self::PendingKeyState, Self::KeyState>, KeyEvents<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).

fn handle_event( &self, pending_state: &mut Self::PendingKeyState, context: &Self::Context, key_path: KeyPath, event: Event<Self::Event>, ) -> (Option<PressedKeyResult<Self::PendingKeyState, Self::KeyState>>, KeyEvents<Self::Event>)

Update the given pending key state with the given impl.

fn lookup( &self, path: &[u16], ) -> &dyn Key<Context = Self::Context, Event = Self::Event, PendingKeyState = Self::PendingKeyState, KeyState = Self::KeyState>

Return a reference to the key for the given path.

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>