Enum Key

pub enum Key {
    Alt,
    AltGr,
    Backspace,
    CapsLock,
    ControlLeft,
    ControlRight,
    Delete,
    DownArrow,
    End,
    Escape,
    F1,
    F10,
    F11,
    F12,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
    F20,
    F21,
    F22,
    F23,
    F24,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    Home,
    LeftArrow,
    MetaLeft,
    MetaRight,
    PageDown,
    PageUp,
    Return,
    RightArrow,
    ShiftLeft,
    ShiftRight,
    Space,
    Tab,
    UpArrow,
    PrintScreen,
    ScrollLock,
    Pause,
    NumLock,
    BackQuote,
    Num1,
    Num2,
    Num3,
    Num4,
    Num5,
    Num6,
    Num7,
    Num8,
    Num9,
    Num0,
    Minus,
    Equal,
    KeyQ,
    KeyW,
    KeyE,
    KeyR,
    KeyT,
    KeyY,
    KeyU,
    KeyI,
    KeyO,
    KeyP,
    LeftBracket,
    RightBracket,
    KeyA,
    KeyS,
    KeyD,
    KeyF,
    KeyG,
    KeyH,
    KeyJ,
    KeyK,
    KeyL,
    SemiColon,
    Quote,
    BackSlash,
    IntlBackslash,
    IntlRo,
    IntlYen,
    KanaMode,
    KeyZ,
    KeyX,
    KeyC,
    KeyV,
    KeyB,
    KeyN,
    KeyM,
    Comma,
    Dot,
    Slash,
    Insert,
    KpReturn,
    KpMinus,
    KpPlus,
    KpMultiply,
    KpDivide,
    KpDecimal,
    KpEqual,
    KpComma,
    Kp0,
    Kp1,
    Kp2,
    Kp3,
    Kp4,
    Kp5,
    Kp6,
    Kp7,
    Kp8,
    Kp9,
    VolumeUp,
    VolumeDown,
    VolumeMute,
    Lang1,
    Lang2,
    Lang3,
    Lang4,
    Lang5,
    Function,
    Apps,
    Cancel,
    Clear,
    Kana,
    Hangul,
    Junja,
    Final,
    Hanja,
    Hanji,
    Print,
    Select,
    Execute,
    Help,
    Sleep,
    Separator,
    Unknown(u32),
    RawKey(RawKey),
}

Key names here assume a QWERTY layout. If you want to detect what actual character was created by a keypress, use Event.unicode instead.

Warning: on Windows, KpReturn does not exist; it’ s strictly equivalent to Return. Also, keypad keys get modified if NumLock is off, directly outputting their associated function (e.g. PageDown).

Variants

Alt

Alt key on Linux and Windows (option key on macOS)

AltGr

Backspace

CapsLock

ControlLeft

ControlRight

Delete

DownArrow

End

Escape

F1

F10

F11

F12

F13

F14

F15

F16

F17

F18

F19

F20

F21

F22

F23

F24

F2

F3

F4

F5

F6

F7

F8

F9

Home

LeftArrow

MetaLeft

Also known as “windows”, “super”, and “command”

MetaRight

Also known as “windows”, “super”, and “command”

PageDown

PageUp

Return

RightArrow

ShiftLeft

ShiftRight

Space

Tab

UpArrow

PrintScreen

ScrollLock

Pause

NumLock

BackQuote

Num1

Num2

Num3

Num4

Num5

Num6

Num7

Num8

Num9

Num0

Minus

Equal

KeyQ

KeyW

KeyE

KeyR

KeyT

KeyY

KeyU

KeyI

KeyO

KeyP

LeftBracket

RightBracket

KeyA

KeyS

KeyD

KeyF

KeyG

KeyH

KeyJ

KeyK

KeyL

SemiColon

Quote

BackSlash

IntlBackslash

IntlRo

IntlYen

KanaMode

KeyZ

KeyX

KeyC

KeyV

KeyB

KeyN

KeyM

Comma

Dot

Slash

Insert

KpReturn

KpMinus

KpPlus

KpMultiply

KpDivide

KpDecimal

KpEqual

KpComma

Kp0

Kp1

Kp2

Kp3

Kp4

Kp5

Kp6

Kp7

Kp8

Kp9

VolumeUp

VolumeDown

VolumeMute

Lang1

Lang2

Lang3

Lang4

Lang5

Function

Apps

Cancel

Clear

Kana

Hangul

Junja

Final

Hanja

Hanji

Print

Select

Execute

Help

Sleep

Separator

Unknown(u32)

RawKey(RawKey)

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

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

Formats the value using the given formatter.

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

type Iterator = KeyIter

fn iter() -> KeyIter

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

impl Eq for Key

impl StructuralPartialEq for Key