Enum Key 

#[non_exhaustive]
pub enum Key {
    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,
    Num0,
    Num1,
    Num2,
    Num3,
    Num4,
    Num5,
    Num6,
    Num7,
    Num8,
    Num9,
    PlayPause,
    Stop,
    PrevTrack,
    NextTrack,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
    F20,
    F21,
    F22,
    F23,
    F24,
    Space,
    Return,
    Tab,
    Escape,
    Delete,
    ForwardDelete,
    Insert,
    Pause,
    Home,
    End,
    PageUp,
    PageDown,
    LeftArrow,
    RightArrow,
    UpArrow,
    DownArrow,
    Minus,
    Equal,
    LeftBracket,
    RightBracket,
    Backslash,
    Semicolon,
    Quote,
    Comma,
    Period,
    Slash,
    Grave,
    Section,
    JisYen,
    JisUnderscore,
    JisEisu,
    JisKana,
    Keypad0,
    Keypad1,
    Keypad2,
    Keypad3,
    Keypad4,
    Keypad5,
    Keypad6,
    Keypad7,
    Keypad8,
    Keypad9,
    KeypadDecimal,
    KeypadMultiply,
    KeypadPlus,
    KeypadClear,
    KeypadDivide,
    KeypadEnter,
    KeypadMinus,
    KeypadEquals,
    KeypadComma,
    CapsLock,
    ScrollLock,
    NumLock,
    PrintScreen,
    ContextMenu,
    Dictation,
    MouseLeft,
    MouseRight,
    MouseMiddle,
    MouseX1,
    MouseX2,
}

Keyboard keys and mouse buttons that can be used in hotkey combinations

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

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

Num0

Num1

Num2

Num3

Num4

Num5

Num6

Num7

Num8

Num9

PlayPause

Stop

PrevTrack

NextTrack

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

F13

F14

F15

F16

F17

F18

F19

F20

F21

F21–F24 exist on Windows (VK 0x84–0x87) and in evdev; macOS virtual keycodes stop at F20, so these are unreachable from macOS hardware.

F22

F23

F24

Space

Return

Tab

Escape

Delete

ForwardDelete

Insert

Pause

The Pause/Break key.

Windows delivers this key’s release together with its press: the hardware break sequence is part of the make sequence (E1 1D 45 E1 9D C5, nothing on release — PS/2 behavior the HID driver preserves for USB keyboards), so the hook sees key-down and key-up back to back at press time. Treat it as tap/toggle only on Windows; a hold binding would release immediately. Ctrl+Pause reports VK_CANCEL rather than VK_PAUSE; both map here. Linux evdev reports normal press/release for USB keyboards, so holds work there. macOS has no virtual keycode for Pause — PC keyboards’ Pause key arrives as F15.

Home

End

PageUp

PageDown

LeftArrow

RightArrow

UpArrow

DownArrow

Minus

Equal

LeftBracket

RightBracket

Backslash

Semicolon

Quote

Comma

Period

Slash

Grave

Section

JisYen

JisUnderscore

JisEisu

JisKana

Keypad0

Keypad1

Keypad2

Keypad3

Keypad4

Keypad5

Keypad6

Keypad7

Keypad8

Keypad9

KeypadDecimal

KeypadMultiply

KeypadPlus

KeypadClear

KeypadDivide

KeypadEnter

KeypadMinus

KeypadEquals

KeypadComma

CapsLock

ScrollLock

NumLock

PrintScreen

The PrintScreen/SysRq key. Windows and Linux only: macOS has no virtual keycode for it — PC keyboards’ PrintScreen arrives as F13 there.

ContextMenu

The context-menu (Application) key, right of AltGr on full-size PC keyboards. VK_APPS on Windows, KEY_COMPOSE on Linux evdev; macOS reports PC keyboards’ Menu key as keycode 0x6E.

Dictation

The dictation / voice key (macOS virtual keycode 0xB0, macOS only).

Emitted by the microphone/dictation key on the media function row (the F5 position on recent Apple keyboards), and by the Globe/Fn key when System Settings configures it to start dictation. A Globe tap configured for anything else emits Fn modifier flags plus a different keycode instead.

Hardware events carry MaskSecondaryFn in their flags, so hotkeys recorded from a key press pair this with the Fn modifier (a string-configured "dictation" hotkey without fn will not match hardware presses until FN matching is reworked).

MouseLeft

MouseRight

MouseMiddle

MouseX1

Extra button 1 (often “back” on mice with side buttons)

MouseX2

Extra button 2 (often “forward” on mice with side buttons)

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl FromStr for Key

fn from_str(s: &str) -> Result<Self>

Parse a key from its string representation (case-insensitive)

type Err = Error

The associated error which can be returned from parsing.

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

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Key

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Key