Enum Key

#[repr(i32)]
pub enum Key {
    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,
}

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

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.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for Key

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Key, Error>

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Key

Returns the “default value” for a type.

impl<UT> FfiConverter<UT> for Key

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Key) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Key, Error>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Key, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Key, Error>

Read a rust value from a buffer, received over the FFI in serialized form.

impl Hash for Key

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

where __H: Hasher,

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<UT> Lift<UT> for Key

type FfiType = <Key as FfiConverter<UT>>::FfiType

fn try_lift(v: <Key as Lift<UT>>::FfiType) -> Result<Key, Error>

fn try_read(buf: &mut &[u8]) -> Result<Key, Error>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for Key

type LiftType = Key

impl<UT> LiftReturn<UT> for Key

type ReturnType = <Key as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return( v: <Key as LiftReturn<UT>>::ReturnType, ) -> Result<Key, Error>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for Key

type FfiType = <Key as FfiConverter<UT>>::FfiType

fn lower(obj: Key) -> <Key as Lower<UT>>::FfiType

fn write(obj: Key, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for Key

fn lower_error(obj: Key) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for Key

type ReturnType = <Key as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return( v: Key, ) -> Result<<Key as LowerReturn<UT>>::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

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

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

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.

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 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<UT> TypeId<UT> for Key

const TYPE_ID_META: MetadataBuffer

impl Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key