pub struct Key<K> { /* private fields */ }
Expand description
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§
Source§impl<K: Key + Copy> Key<K>
impl<K: Key + Copy> Key<K>
Sourcepub fn new_pressed_key(
&self,
context: K::Context,
keymap_index: u16,
) -> (PressedKey<Self, PressedKeyState<K>>, PressedKeyEvents<K::Event>)
pub fn new_pressed_key( &self, context: K::Context, keymap_index: u16, ) -> (PressedKey<Self, PressedKeyState<K>>, PressedKeyEvents<K::Event>)
Constructs new pressed key.
Trait Implementations§
Source§impl<K: Key> ChordedKey<K> for Key<K>
impl<K: Key> ChordedKey<K> for Key<K>
Source§fn passthrough_key(&self) -> &K
fn passthrough_key(&self) -> &K
The chorded key’s “passthrough” key.
Source§fn chorded_key(&self) -> Option<&K>
fn chorded_key(&self) -> Option<&K>
The chorded key’s “chorded” key.
Source§impl<'de, K> Deserialize<'de> for Key<K>where
K: Deserialize<'de>,
impl<'de, K> Deserialize<'de> for Key<K>where
K: Deserialize<'de>,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl<K: ChordedNestable> Key for Key<K>
impl<K: ChordedNestable> Key for Key<K>
Source§type Context = Context
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).
Source§type PressedKey = PressedKey<ChordedKey<LayeredKey<TapHoldKey<BaseKey>>>, ChordedPressedKeyState<LayeredKey<TapHoldKey<BaseKey>>>>
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’).
Source§fn new_pressed_key(
&self,
context: Self::Context,
keymap_index: u16,
) -> (Self::PressedKey, PressedKeyEvents<Self::Event>)
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: Copy> Copy for Key<K>
impl<K> StructuralPartialEq for Key<K>
Auto Trait Implementations§
impl<K> Freeze for Key<K>where
K: Freeze,
impl<K> RefUnwindSafe for Key<K>where
K: RefUnwindSafe,
impl<K> Send for Key<K>where
K: Send,
impl<K> Sync for Key<K>where
K: Sync,
impl<K> Unpin for Key<K>where
K: Unpin,
impl<K> UnwindSafe for Key<K>where
K: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more