Enum kb_remap::Key

#[non_exhaustive]
pub enum Key {
    Return,
    Escape,
    Delete,
    CapsLock,
    Char(char),
    Raw(u64),
}

A key on a keyboard.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Return

⏎

Escape

ESC

Delete

⌫

CapsLock

⇪

Char(char)

A character on the keyboard.

Examples

use kb_remap::Key;

let a = Key::Char('a');
let b = Key::Char('B');
let zero = Key::Char('0');
let percent = Key::Char('%');

Raw(u64)

Any key by its usage ID.

This can be used to represent any key that is not enumerated in this type. See USB HID Usage Tables Specification, Section 10 Keyboard/Keypad Page for exact values for each key.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl FromStr for Key

type Err = ParseKeyError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Key

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Key> for Key

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Key

impl StructuralPartialEq for Key