pub enum BaseKey {
LayerModifier(ModifierKey),
Keyboard(Key),
}
Expand description
An aggregate of key::Key types.
Variants§
Implementations§
Source§impl BaseKey
impl BaseKey
Sourcepub const fn keyboard(key: Key) -> Self
pub const fn keyboard(key: Key) -> Self
Constructs a BaseKey::Keyboard from the given keyboard::Key.
Sourcepub const fn layer_modifier(key: ModifierKey) -> Self
pub const fn layer_modifier(key: ModifierKey) -> Self
Constructs a BaseKey::LayerModifier from the given layered::ModifierKey.
Trait Implementations§
Source§impl<'de> Deserialize<'de> for BaseKey
impl<'de> Deserialize<'de> for BaseKey
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 From<ModifierKey> for BaseKey
impl From<ModifierKey> for BaseKey
Source§fn from(key: ModifierKey) -> Self
fn from(key: ModifierKey) -> Self
Converts to this type from the input type.
Source§impl Key for BaseKey
impl Key for BaseKey
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<BaseKey, BasePressedKeyState>
type PressedKey = PressedKey<BaseKey, BasePressedKeyState>
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 Copy for BaseKey
impl StructuralPartialEq for BaseKey
impl TapHoldNestable for BaseKey
Auto Trait Implementations§
impl Freeze for BaseKey
impl RefUnwindSafe for BaseKey
impl Send for BaseKey
impl Sync for BaseKey
impl Unpin for BaseKey
impl UnwindSafe for BaseKey
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