Enum Key 

pub enum Key {
    A,
    B,
    C,
    D,
    E,
    F,
    G,
    H,
    I,
    J,
    K,
    L,
    M,
    N,
    O,
    P,
    Q,
    R,
    S,
    T,
    U,
    V,
    W,
    X,
    Y,
    Z,
    Digit0,
    Digit1,
    Digit2,
    Digit3,
    Digit4,
    Digit5,
    Digit6,
    Digit7,
    Digit8,
    Digit9,
    Semicolon,
    Up,
    Down,
    Left,
    Right,
    Enter,
    Escape,
    Space,
    Tab,
    Backspace,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    Comma,
    Period,
    Slash,
    Apostrophe,
    LeftBracket,
    RightBracket,
    Backslash,
    Minus,
    Equal,
    Backquote,
    Insert,
    Delete,
    Home,
    End,
    PageUp,
    PageDown,
    Kp0,
    Kp1,
    Kp2,
    Kp3,
    Kp4,
    Kp5,
    Kp6,
    Kp7,
    Kp8,
    Kp9,
    KpAdd,
    KpSubtract,
    KpMultiply,
    KpDivide,
    KpDecimal,
}

A hardware-agnostic keyboard key. app translates platform key codes to these; anything without a variant is ignored.

Variants

A

The a key.

B

The b key.

C

The c key.

D

The d key.

E

The e key.

F

The f key.

G

The g key.

H

The h key.

I

The i key.

J

The j key.

K

The k key.

L

The l key.

M

The m key.

N

The n key.

O

The o key.

P

The p key.

Q

The q key.

R

The r key.

S

The s key.

T

The t key.

U

The u key.

V

The v key.

W

The w key.

X

The x key.

Y

The y key.

Z

The z key.

Digit0

The 0 key.

Digit1

The 1 key.

Digit2

The 2 key.

Digit3

The 3 key.

Digit4

The 4 key.

Digit5

The 5 key.

Digit6

The 6 key.

Digit7

The 7 key.

Digit8

The 8 key.

Digit9

The 9 key.

Semicolon

The ; key.

Up

The Up key.

Down

The Down key.

Left

The Left key.

Right

The Right key.

Enter

The Enter key.

Escape

The Escape key.

Space

The Space key.

Tab

The Tab key.

Backspace

The Backspace key.

F1

The F1 key.

F2

The F2 key.

F3

The F3 key.

F4

The F4 key.

F5

The F5 key.

F6

The F6 key.

F7

The F7 key.

F8

The F8 key.

F9

The F9 key.

F10

The F10 key.

F11

The F11 key.

F12

The F12 key.

Comma

The , key.

Period

The . key.

Slash

The / key.

Apostrophe

The ' key.

LeftBracket

The [ key.

RightBracket

The ] key.

Backslash

The \ key.

Minus

The - key.

Equal

The = key.

Backquote

The ` key.

Insert

The Insert key.

Delete

The Delete key.

Home

The Home key.

End

The End key.

PageUp

The PageUp key.

PageDown

The PageDown key.

Kp0

The Kp0 key.

Kp1

The Kp1 key.

Kp2

The Kp2 key.

Kp3

The Kp3 key.

Kp4

The Kp4 key.

Kp5

The Kp5 key.

Kp6

The Kp6 key.

Kp7

The Kp7 key.

Kp8

The Kp8 key.

Kp9

The Kp9 key.

KpAdd

The Kp+ key.

KpSubtract

The Kp- key.

KpMultiply

The Kp* key.

KpDivide

The Kp/ key.

KpDecimal

The Kp. key.

Implementations

impl Key

pub const ALL: &'static [Key]

Every key, in declaration order.

pub fn name(self) -> &'static str

The name used in keymap files: lowercase letters (h), digits (0), punctuation as itself (;, ,, \), numpad keys prefixed Kp (Kp0, Kp+), and capitalised names for the rest (Left, F12).

impl Key

pub fn from_name(name: &str) -> Option<Self>

Looks a key up by its name (exact match).

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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<'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 Display for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl Hash for Key

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Key

fn cmp(&self, other: &Key) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Key

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Key

fn partial_cmp(&self, other: &Key) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Key

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Key