Enum keyberon::key_code::KeyCode

#[repr(u8)]pub enum KeyCode {
    No,
    ErrorRollOver,
    PostFail,
    ErrorUndefined,
    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,
    Kb1,
    Kb2,
    Kb3,
    Kb4,
    Kb5,
    Kb6,
    Kb7,
    Kb8,
    Kb9,
    Kb0,
    Enter,
    Escape,
    BSpace,
    Tab,
    Space,
    Minus,
    Equal,
    LBracket,
    RBracket,
    Bslash,
    NonUsHash,
    SColon,
    Quote,
    Grave,
    Comma,
    Dot,
    Slash,
    CapsLock,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    PScreen,
    ScrollLock,
    Pause,
    Insert,
    Home,
    PgUp,
    Delete,
    End,
    PgDown,
    Right,
    Left,
    Down,
    Up,
    NumLock,
    KpSlash,
    KpAsterisk,
    KpMinus,
    KpPlus,
    KpEnter,
    Kp1,
    Kp2,
    Kp3,
    Kp4,
    Kp5,
    Kp6,
    Kp7,
    Kp8,
    Kp9,
    Kp0,
    KpDot,
    NonUsBslash,
    Application,
    Power,
    KpEqual,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
    F20,
    F21,
    F22,
    F23,
    F24,
    Execute,
    Help,
    Menu,
    Select,
    Stop,
    Again,
    Undo,
    Cut,
    Copy,
    Paste,
    Find,
    Mute,
    VolUp,
    VolDown,
    LockingCapsLock,
    LockingNumLock,
    LockingScrollLock,
    KpComma,
    KpEqualSign,
    Intl1,
    Intl2,
    Intl3,
    Intl4,
    Intl5,
    Intl6,
    Intl7,
    Intl8,
    Intl9,
    Lang1,
    Lang2,
    Lang3,
    Lang4,
    Lang5,
    Lang6,
    Lang7,
    Lang8,
    Lang9,
    AltErase,
    SysReq,
    Cancel,
    Clear,
    Prior,
    Return,
    Separator,
    Out,
    Oper,
    ClearAgain,
    CrSel,
    ExSel,
    LCtrl,
    LShift,
    LAlt,
    LGui,
    RCtrl,
    RShift,
    RAlt,
    RGui,
    MediaPlayPause,
    MediaStopCD,
    MediaPreviousSong,
    MediaNextSong,
    MediaEjectCD,
    MediaVolUp,
    MediaVolDown,
    MediaMute,
    MediaWWW,
    MediaBack,
    MediaForward,
    MediaStop,
    MediaFind,
    MediaScrollUp,
    MediaScrollDown,
    MediaEdit,
    MediaSleep,
    MeidaCoffee,
    MediaRefresh,
    MediaCalc,
}

Define a key code according to the HID specification. Their names correspond to the american QWERTY layout.

Variants

No

The "no" key, a placeholder to express nothing.

ErrorRollOver

Error if too much keys are pressed at the same time.

PostFail

The POST fail error.

ErrorUndefined

An undefined error occured.

A

a and 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

Kb1

1 and !.

Kb2

2 and @.

Kb3

3 and #.

Kb4

4 and $.

Kb5

5 and %.

Kb6

6 and ^.

Kb7

7 and &.

Kb8

8 and *.

Kb9

9 and (.

Kb0

0 and ).

Enter

Escape

BSpace

Tab

Space

Minus

- and _.

Equal

= and +.

LBracket

[ and {.

RBracket

] and }.

Bslash

\ and |.

NonUsHash

Non-US # and ~ (Typically near the Enter key).

SColon

; and :.

Quote

' and ".

Grave

` and ~.

Comma

, and <.

Dot

. and >.

Slash

/ and ?.

CapsLock

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

PScreen

ScrollLock

Pause

Insert

Home

PgUp

Delete

End

PgDown

Right

Left

Down

Up

NumLock

KpSlash

Keypad /

KpAsterisk

Keypad *

KpMinus

Keypad -.

KpPlus

Keypad +.

KpEnter

Keypad enter.

Kp1

Keypad 1.

Kp2

Kp3

Kp4

Kp5

Kp6

Kp7

Kp8

Kp9

Kp0

KpDot

NonUsBslash

Non-US \ and | (Typically near the Left-Shift key)

Application

Power

not a key, used for errors

KpEqual

Keypad =.

F13

F14

F15

F16

F17

F18

F19

F20

F21

F22

F23

F24

Execute

Help

Menu

Select

Stop

Again

Undo

Cut

Copy

Paste

Find

Mute

VolUp

VolDown

LockingCapsLock

Deprecated.

LockingNumLock

Deprecated.

LockingScrollLock

Deprecated.

KpComma

Keypad ,, also used for the brazilian keypad period (.) key.

KpEqualSign

Used on AS/400 keyboard

Intl1

Intl2

Intl3

Intl4

Intl5

Intl6

Intl7

Intl8

Intl9

Lang1

Lang2

Lang3

Lang4

Lang5

Lang6

Lang7

Lang8

Lang9

AltErase

SysReq

Cancel

Clear

Prior

Return

Separator

Out

Oper

ClearAgain

CrSel

ExSel

LCtrl

Left Control.

LShift

Left Shift.

LAlt

Left Alt.

LGui

Left GUI (the Windows key).

RCtrl

Right Control.

RShift

Right Shift.

RAlt

Right Alt (or Alt Gr).

RGui

Right GUI (the Windows key).

MediaPlayPause

MediaStopCD

MediaPreviousSong

MediaNextSong

MediaEjectCD

MediaVolUp

MediaVolDown

MediaMute

MediaWWW

MediaBack

MediaForward

MediaStop

MediaFind

MediaScrollUp

MediaScrollDown

MediaEdit

MediaSleep

MeidaCoffee

MediaRefresh

MediaCalc

Implementations

impl KeyCode

pub fn is_modifier(self) -> bool

Returns true if the key code correspond to a modifier (send separately on USB HID report).

pub fn as_modifier_bit(self) -> u8

Returns the byte with the bit corresponding to the USB HID modifier bitfield setted.

Trait Implementations

impl Clone for KeyCode

fn clone(&self) -> KeyCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for KeyCode

impl Debug for KeyCode

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

Formats the value using the given formatter.

impl Eq for KeyCode

impl FromIterator<KeyCode> for KbHidReport

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = KeyCode>, 

Creates a value from an iterator.

impl Ord for KeyCode

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<KeyCode> for KeyCode

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<KeyCode> for KeyCode

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for KeyCode

impl StructuralPartialEq for KeyCode