Enum keytokey::KeyCode

#[repr(u32)]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,
    Open,
    Help,
    Props,
    Front,
    Stop,
    Again,
    Undo,
    Cut,
    Copy,
    Paste,
    Find,
    Mute,
    VolumeUp,
    VolumeDown,
    Kpcomma,
    Ro,
    Katakanahiragana,
    Yen,
    Henkan,
    Muhenkan,
    KpJpComma,
    Hangeul,
    Hanja,
    Katakana,
    Hiragana,
    Zenkakuhankaku,
    KpLeftParen,
    KpRightParen,
    LCtrl,
    LShift,
    LAlt,
    LGui,
    RCtrl,
    RShift,
    RAlt,
    RGui,
    MediaPlayPause,
    MediaStopCd,
    MediaPrevioussong,
    MediaNextsong,
    MediaEjectCd,
    MediaVolumeUp,
    MediaVolumeDown,
    MediaMUte,
    MediaWww,
    MediaBack,
    MediaForward,
    MediaStop,
    MediaFind,
    MediaScrollUp,
    MediaScrollDown,
    MediaEdit,
    MediaSleep,
    MediaCoffee,
    MediaRefresh,
    MediaCalc,
}

usb key codes mapped into the first private region of unicode USBKeyOut must substract UNICODE_BELOW_256 to create valid u8 values to transmit

Variants

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

Open

Help

Props

Front

0x76, // Keyboard Menu

Stop

Again

Undo

Cut

Copy

Paste

Find

Mute

VolumeUp

VolumeDown

Kpcomma

Ro

Katakanahiragana

Yen

Henkan

Muhenkan

KpJpComma

Hangeul

Hanja

Katakana

Hiragana

Zenkakuhankaku

KpLeftParen

KpRightParen

LCtrl

LShift

LAlt

LGui

RCtrl

RShift

RAlt

RGui

MediaPlayPause

MediaStopCd

MediaPrevioussong

MediaNextsong

MediaEjectCd

MediaVolumeUp

MediaVolumeDown

MediaMUte

MediaWww

MediaBack

MediaForward

MediaStop

MediaFind

MediaScrollUp

MediaScrollDown

MediaEdit

MediaSleep

MediaCoffee

MediaRefresh

MediaCalc

Implementations

impl KeyCode

pub fn is_modifier(self) -> bool

needed to build USB reports

pub fn as_modifier_bit(self) -> u8

needed to build USB reports

pub fn to_u8(self) -> u8

pub const fn to_u32(self) -> u32

Trait Implementations

impl AcceptsKeycode for KeyCode

fn to_u32(&self) -> u32

impl Action for KeyCode

Register a key as an Action

that means the current modifiers are sent as well by USBKeyboard

fn on_trigger(&mut self, output: &mut dyn USBKeyOut)

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 From<KeyCode> for u32

fn from(number: KeyCode) -> Self

Performs the conversion.

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

impl TryFrom<u32> for KeyCode

type Error = String

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, String>

Performs the conversion.

impl TryFrom<u8> for KeyCode

type Error = String

The type returned in the event of a conversion error.

fn try_from(ii: u8) -> Result<KeyCode, Self::Error>

Performs the conversion.