smart_keymap::key::composite

Enum LayeredKey

Source
pub enum LayeredKey<K: LayeredNestable> {
    Layered(LayeredKey<K>),
    Pass(K),
}
Expand description

An aggregate of key::Key types.

Variants§

§

Layered(LayeredKey<K>)

A layered key.

§

Pass(K)

Non-layered,

Implementations§

Source§

impl<K: LayeredNestable> LayeredKey<K>

Source

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

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

Source§

impl LayeredKey<TapHoldKey<BaseKey>>

Source

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

Constructs a [Key] from the given key::keyboard::Key.

Source

pub const fn tap_hold(key: Key<BaseKey>) -> Self

Constructs a [Key] from the given key::tap_hold::Key.

Source

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

Constructs a [Key] from the given key::layered::ModifierKey.

Source§

impl<K: LayeredNestable> LayeredKey<K>

Source

pub const fn layered(key: LayeredKey<K>) -> Self

Constructs a [Key] from the given key::layered::LayeredKey.

Trait Implementations§

Source§

impl<K: LayeredNestable> ChordedNestable for LayeredKey<K>

Source§

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

Construct a ‘full representation’ of the nestable key.
Source§

impl<K: Clone + LayeredNestable> Clone for LayeredKey<K>

Source§

fn clone(&self) -> LayeredKey<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 + LayeredNestable> Debug for LayeredKey<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 LayeredKey<K>
where K: Deserialize<'de> + LayeredNestable,

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: LayeredNestable> Key for LayeredKey<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<LayeredKey<TapHoldKey<BaseKey>>, LayeredPressedKeyState<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 + LayeredNestable> PartialEq for LayeredKey<K>

Source§

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

Source§

impl<K: LayeredNestable> StructuralPartialEq for LayeredKey<K>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<K> UnwindSafe for LayeredKey<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>,