smart_keymap::key::chorded

Struct AuxiliaryKey

Source
pub struct AuxiliaryKey<K> { /* private fields */ }
Expand description

Auxiliary chorded key (with a passthrough key).

The auxiliary keys are chorded keys, but don’t store the resolved chord key. (i.e. After te primary chorded key, the remaining keys in the chord are defined with auxiliary chorded keys).

Implementations§

Source§

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

Source

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

Constructs new auxiliary chorded key.

Source

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

Constructs new pressed key.

Source

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

Maps the Key of the Key into a new type.

Source

pub fn into_key<T: Key + Copy>(self) -> AuxiliaryKey<T>
where K: Into<T>,

Maps the Key of the Key into a new type.

Trait Implementations§

Source§

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

Source§

fn passthrough_key(&self) -> &K

The chorded key’s “passthrough” key.
Source§

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

The chorded key’s “chorded” key.
Source§

impl<K: Clone> Clone for AuxiliaryKey<K>

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K: Debug> Debug for AuxiliaryKey<K>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, K> Deserialize<'de> for AuxiliaryKey<K>
where K: Deserialize<'de>,

Source§

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 AuxiliaryKey<K>

Source§

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 Event = Event

The associated Event is to be handled by the associated Context, and any active PressedKeys.
Source§

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>)

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).
Source§

impl<K: PartialEq> PartialEq for AuxiliaryKey<K>

Source§

fn eq(&self, other: &AuxiliaryKey<K>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<K: Copy> Copy for AuxiliaryKey<K>

Source§

impl<K> StructuralPartialEq for AuxiliaryKey<K>

Auto Trait Implementations§

§

impl<K> Freeze for AuxiliaryKey<K>
where K: Freeze,

§

impl<K> RefUnwindSafe for AuxiliaryKey<K>
where K: RefUnwindSafe,

§

impl<K> Send for AuxiliaryKey<K>
where K: Send,

§

impl<K> Sync for AuxiliaryKey<K>
where K: Sync,

§

impl<K> Unpin for AuxiliaryKey<K>
where K: Unpin,

§

impl<K> UnwindSafe for AuxiliaryKey<K>
where K: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,