Struct Key

pub struct Key { /* private fields */ }

A key for HID Keyboard usage codes.

Implementations

impl Key

pub const fn new(key_code: u8) -> Self

Constructs a key with the given key_code.

pub const fn new_with_modifiers( key_code: u8, modifiers: KeyboardModifiers, ) -> Self

Constructs a key with the given key_code and modifiers.

pub const fn from_modifiers(modifiers: KeyboardModifiers) -> Self

Constructs a key with the given modifiers.

pub fn key_code(&self) -> u8

Gets the key code from Key.

pub fn new_pressed_key(&self) -> PressedKeyState

Constructs a pressed key state

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Key> for BaseKey

fn from(key: Key) -> Self

Converts to this type from the input type.

impl Key for Key

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

type Event = Event

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

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

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 PartialEq for Key

fn eq(&self, other: &Key) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Key

impl StructuralPartialEq for Key

impl TapHoldNestable for Key