mm_protocol::messages::keyboard_input

Enum Key

#[repr(i32)]pub enum Key {
Show 134 variants    Unknown = 0,
    Backquote = 1,
    Backslash = 2,
    BracketLeft = 3,
    BracketRight = 4,
    Comma = 5,
    Digit0 = 10,
    Digit1 = 11,
    Digit2 = 12,
    Digit3 = 13,
    Digit4 = 14,
    Digit5 = 15,
    Digit6 = 16,
    Digit7 = 17,
    Digit8 = 18,
    Digit9 = 19,
    Equal = 20,
    IntlBackslash = 21,
    IntlRo = 22,
    IntlYen = 23,
    A = 30,
    B = 31,
    C = 32,
    D = 33,
    E = 34,
    F = 35,
    G = 36,
    H = 37,
    I = 38,
    J = 39,
    K = 40,
    L = 41,
    M = 42,
    N = 43,
    O = 44,
    P = 45,
    Q = 46,
    R = 47,
    S = 48,
    T = 49,
    U = 50,
    V = 51,
    W = 52,
    X = 53,
    Y = 54,
    Z = 55,
    Minus = 60,
    Period = 61,
    Quote = 62,
    Semicolon = 63,
    Slash = 64,
    AltLeft = 65,
    AltRight = 66,
    Backspace = 67,
    CapsLock = 68,
    ContextMenu = 69,
    ControlLeft = 70,
    ControlRight = 71,
    Enter = 72,
    MetaLeft = 73,
    MetaRight = 74,
    ShiftLeft = 75,
    ShiftRight = 76,
    Space = 77,
    Tab = 78,
    Convert = 79,
    KanaMode = 80,
    Lang1 = 81,
    Lang2 = 82,
    Lang3 = 83,
    Lang4 = 84,
    Lang5 = 85,
    NonConvert = 86,
    Delete = 87,
    End = 88,
    Help = 89,
    Home = 90,
    Insert = 91,
    PageDown = 92,
    PageUp = 93,
    ArrowDown = 94,
    ArrowLeft = 95,
    ArrowRight = 96,
    ArrowUp = 97,
    NumLock = 100,
    Numpad0 = 101,
    Numpad1 = 102,
    Numpad2 = 103,
    Numpad3 = 104,
    Numpad4 = 105,
    Numpad5 = 106,
    Numpad6 = 107,
    Numpad7 = 108,
    Numpad8 = 109,
    Numpad9 = 110,
    NumpadAdd = 111,
    NumpadBackspace = 112,
    NumpadClear = 113,
    NumpadClearEntry = 114,
    NumpadComma = 115,
    NumpadDecimal = 116,
    NumpadDivide = 117,
    NumpadEnter = 118,
    NumpadEqual = 119,
    NumpadHash = 120,
    NumpadMemoryAdd = 121,
    NumpadMemoryClear = 122,
    NumpadMemoryRecall = 123,
    NumpadMemoryStore = 124,
    NumpadMemorySubtract = 125,
    NumpadMultiply = 126,
    NumpadParenLeft = 127,
    NumpadParenRight = 128,
    NumpadSubtract = 129,
    Escape = 200,
    F1 = 201,
    F2 = 202,
    F3 = 203,
    F4 = 204,
    F5 = 205,
    F6 = 206,
    F7 = 207,
    F8 = 208,
    F9 = 209,
    F10 = 210,
    F11 = 211,
    F12 = 212,
    Fn = 213,
    FnLock = 214,
    PrintScreen = 215,
    ScrollLock = 216,
    Pause = 217,
    Hiragana = 218,
    Katakana = 219,
}

Expand description

These map to the keycodes from the W3C “UI Events” specification. It represents the key location, irrespective of keyboard layout or character output.

Media and remote control keys are omitted.

https://w3c.github.io/uievents-code/#code-value-tables

Variants§

Unknown = 0

Backquote = 1

Backslash = 2

BracketLeft = 3

BracketRight = 4

Comma = 5

Digit0 = 10

Digit1 = 11

Digit2 = 12

Digit3 = 13

Digit4 = 14

Digit5 = 15

Digit6 = 16

Digit7 = 17

Digit8 = 18

Digit9 = 19

Equal = 20

IntlBackslash = 21

IntlRo = 22

IntlYen = 23

A = 30

B = 31

C = 32

D = 33

E = 34

F = 35

G = 36

H = 37

I = 38

J = 39

K = 40

L = 41

M = 42

N = 43

O = 44

P = 45

Q = 46

R = 47

S = 48

T = 49

U = 50

V = 51

W = 52

X = 53

Y = 54

Z = 55

Minus = 60

Period = 61

Quote = 62

Semicolon = 63

Slash = 64

AltLeft = 65

AltRight = 66

Backspace = 67

CapsLock = 68

ContextMenu = 69

ControlLeft = 70

ControlRight = 71

Enter = 72

MetaLeft = 73

MetaRight = 74

ShiftLeft = 75

ShiftRight = 76

Space = 77

Tab = 78

Convert = 79

KanaMode = 80

Lang1 = 81

Lang2 = 82

Lang3 = 83

Lang4 = 84

Lang5 = 85

NonConvert = 86

Delete = 87

End = 88

Help = 89

Home = 90

Insert = 91

PageDown = 92

PageUp = 93

ArrowDown = 94

ArrowLeft = 95

ArrowRight = 96

ArrowUp = 97

NumLock = 100

Numpad0 = 101

Numpad1 = 102

Numpad2 = 103

Numpad3 = 104

Numpad4 = 105

Numpad5 = 106

Numpad6 = 107

Numpad7 = 108

Numpad8 = 109

Numpad9 = 110

NumpadAdd = 111

NumpadBackspace = 112

NumpadClear = 113

NumpadClearEntry = 114

NumpadComma = 115

NumpadDecimal = 116

NumpadDivide = 117

NumpadEnter = 118

NumpadEqual = 119

NumpadHash = 120

NumpadMemoryAdd = 121

NumpadMemoryClear = 122

NumpadMemoryRecall = 123

NumpadMemoryStore = 124

NumpadMemorySubtract = 125

NumpadMultiply = 126

NumpadParenLeft = 127

NumpadParenRight = 128

NumpadSubtract = 129

Escape = 200

F1 = 201

F2 = 202

F3 = 203

F4 = 204

F5 = 205

F6 = 206

F7 = 207

F8 = 208

F9 = 209

F10 = 210

F11 = 211

F12 = 212

Fn = 213

FnLock = 214

PrintScreen = 215

ScrollLock = 216

Pause = 217

Hiragana = 218

Katakana = 219

Implementations§

impl Key

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of Key.

pub fn from_i32(value: i32) -> Option<Key>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a Key, or None if value is not a valid variant.

impl Key

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

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations§

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Key

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

Formats the value using the given formatter. Read more

impl Default for Key

fn default() -> Key

Returns the “default value” for a type. Read more

impl From<Key> for i32

fn from(value: Key) -> i32

Converts to this type from the input type.

impl Hash for Key

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl Ord for Key

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

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

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

Restrict a value to a certain interval. Read more

impl PartialEq for Key

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

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

1.0.0 · Source§

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

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

impl TryFrom<i32> for Key

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Key, UnknownEnumValue>

Performs the conversion.

impl Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key

Auto Trait Implementations§

impl Freeze for Key

impl RefUnwindSafe for Key

impl Send for Key

impl Sync for Key

impl Unpin for Key

impl UnwindSafe for Key

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

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

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.