Enum Key

pub enum Key {
    MouseLeft,
    MouseRight,
    MouseMiddle,
    MouseX(u8),
    Backspace,
    Tab,
    Clear,
    Enter,
    Shift,
    LeftShift,
    RightShift,
    Control,
    LeftControl,
    RightControl,
    Menu,
    LeftMenu,
    RightMenu,
    Home,
    LeftWindows,
    RightWindows,
    Pause,
    CapsLock,
    Escape,
    Space,
    PageUp,
    PageDown,
    End,
    Select,
    Print,
    Execute,
    PrintScreen,
    Insert,
    Delete,
    Help,
    Apps,
    Sleep,
    BrowserBack,
    BrowserForward,
    BrowserRefresh,
    BrowserStop,
    BrowserSearch,
    BrowserFavorites,
    BrowserHome,
    VolumeMute,
    VolumeDown,
    VolumeUp,
    MediaNextTrack,
    MediaPreviousTrack,
    MediaStop,
    MediaPlayPause,
    LaunchMail,
    SelectMedia,
    LaunchApp1,
    LaunchApp2,
    Attn,
    Crsel,
    Exsel,
    Ereof,
    Play,
    Zoom,
    NoName,
    Left,
    Up,
    Right,
    Down,
    Kana,
    Hangul,
    Junja,
    Final,
    Kanji,
    Convert,
    Nonconvert,
    Accept,
    ModeChange,
    ProcessKey,
    ImeOn,
    ImeOff,
    Oem1,
    OemPlus,
    OemComma,
    OemMinus,
    OemPeriod,
    Oem2,
    Oem3,
    Oem4,
    Oem5,
    Oem6,
    Oem7,
    Oem8,
    Oem102,
    OemClear,
    _0,
    _1,
    _2,
    _3,
    _4,
    _5,
    _6,
    _7,
    _8,
    _9,
    Numpad0,
    Numpad1,
    Numpad2,
    Numpad3,
    Numpad4,
    Numpad5,
    Numpad6,
    Numpad7,
    Numpad8,
    Numpad9,
    Multiply,
    Add,
    Subtract,
    Decimal,
    Divide,
    Separator,
    NumLock,
    ScrollLock,
    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,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
    F20,
    F21,
    F22,
    F23,
    F24,
}

A key that can be pressed.

Variants

MouseLeft

MouseRight

MouseMiddle

MouseX(u8)

Backspace

Also named BACK

Tab

Clear

Enter

Also named RETURN

Shift

LeftShift

RightShift

Control

LeftControl

RightControl

Menu

LeftMenu

RightMenu

Home

LeftWindows

RightWindows

Pause

CapsLock

Also named CAPITAL

Escape

Space

PageUp

Also named PRIOR

PageDown

Also named NEXT

End

Select

Print

Execute

PrintScreen

Also named SNAPSHOT

Insert

Delete

Help

Apps

Sleep

BrowserBack

BrowserForward

BrowserRefresh

BrowserStop

BrowserSearch

BrowserFavorites

BrowserHome

VolumeMute

VolumeDown

VolumeUp

MediaNextTrack

MediaPreviousTrack

MediaStop

MediaPlayPause

LaunchMail

SelectMedia

LaunchApp1

LaunchApp2

Attn

Crsel

Exsel

Ereof

Play

Zoom

NoName

Left

Up

Right

Down

Kana

Hangul

Junja

Final

Kanji

Convert

Nonconvert

Accept

ModeChange

ProcessKey

The IME PROCESS key

ImeOn

ImeOff

Oem1

On US keyboards, the ‘;:’ key.

OemPlus

On US keyboards, the ‘+’ key.

OemComma

On US keyboards, the ‘,’ key.

OemMinus

On US keyboards, the ‘-’ key.

OemPeriod

On US keyboards, the ‘.’ key.

Oem2

On US keyboards, the ‘/’ key.

Oem3

On US keyboards, the ‘~’ key.

Oem4

On US keyboards, the ‘[{’ key.

Oem5

On US keyboards, the ‘|’ key.

Oem6

On US keyboards, the ‘]}’

Oem7

On US keyboards, the ‘’“’ key.

Oem8

Miscellaneous characters; can vary by keyboard.

Oem102

Either the angle backet key or the backslash on the RT 102-key keyboard.

OemClear

_0

_1

_2

_3

_4

_5

_6

_7

_8

_9

Numpad0

Numpad1

Numpad2

Numpad3

Numpad4

Numpad5

Numpad6

Numpad7

Numpad8

Numpad9

Multiply

Add

Subtract

Decimal

Divide

Separator

NumLock

ScrollLock

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

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

F13

F14

F15

F16

F17

F18

F19

F20

F21

F22

F23

F24

Implementations

impl Key

pub fn is_mouse_button(&self) -> bool

Checks if this Key is a mouse button.

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

fn into_event(self, action: Action) -> Event

Turns the keylike into an event.

fn press(self) -> Event

Creates an event that causes the keylike to be pressed.

fn release(self) -> Event

Creates an event that causes the keylike to be released.

fn press_release(self) -> Chain<Once<Event>, Once<Event>>

Creates an iterator that yield a Press event and a Release for this keylike.

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