pub struct Key { /* private fields */ }
Expand description
A key for HID Keyboard usage codes.
Implementations§
Source§impl Key
impl Key
Sourcepub const fn new_with_modifiers(
key_code: u8,
modifiers: KeyboardModifiers,
) -> Self
pub const fn new_with_modifiers( key_code: u8, modifiers: KeyboardModifiers, ) -> Self
Constructs a key with the given key_code and modifiers.
Sourcepub const fn from_modifiers(modifiers: KeyboardModifiers) -> Self
pub const fn from_modifiers(modifiers: KeyboardModifiers) -> Self
Constructs a key with the given modifiers.
Sourcepub fn new_pressed_key(&self) -> PressedKeyState
pub fn new_pressed_key(&self) -> PressedKeyState
Constructs a pressed key state
Trait Implementations§
Source§impl<'de> Deserialize<'de> for Key
impl<'de> Deserialize<'de> for Key
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 Key for Key
impl Key for Key
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 Key
impl StructuralPartialEq for Key
impl TapHoldNestable for Key
Auto Trait Implementations§
impl Freeze for Key
impl RefUnwindSafe for Key
impl Send for Key
impl Sync for Key
impl Unpin for Key
impl UnwindSafe for Key
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