Enum KeyCode 

#[non_exhaustive]
pub enum KeyCode {
    Char(char),
    Enter,
    Backspace,
    Tab,
    BackTab,
    Esc,
    Up,
    Down,
    Left,
    Right,
    Home,
    End,
    PageUp,
    PageDown,
    Delete,
    Insert,
    Null,
    CapsLock,
    ScrollLock,
    NumLock,
    PrintScreen,
    Pause,
    Menu,
    KeypadBegin,
    F(u8),
    Modifier(ModifierKey),
}

Key identifier.

Covers printable characters, control keys, arrow keys, function keys, and navigation keys. Unrecognized keys are silently dropped by the crossterm conversion layer.

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.

Char(char)

A printable character (letter, digit, symbol, space, etc.).

Enter

Enter / Return key.

Backspace

Backspace key.

Tab

Tab key (forward tab).

BackTab

Shift+Tab (back tab).

Esc

Escape key.

Up

Up arrow key.

Down

Down arrow key.

Left

Left arrow key.

Right

Right arrow key.

Home

Home key.

End

End key.

PageUp

Page Up key.

PageDown

Page Down key.

Delete

Delete (forward delete) key.

Insert

Insert key.

Null

Null key (Ctrl+Space on some terminals).

CapsLock

Caps Lock key (Kitty keyboard protocol only).

ScrollLock

Scroll Lock key (Kitty keyboard protocol only).

NumLock

Num Lock key (Kitty keyboard protocol only).

PrintScreen

Print Screen key (Kitty keyboard protocol only).

Pause

Pause/Break key (Kitty keyboard protocol only).

Menu

Menu / context menu key.

KeypadBegin

Keypad center key (numpad 5 without NumLock).

F(u8)

Function key F1..F12 (and beyond). The inner u8 is the number.

Modifier(ModifierKey)

A modifier key pressed on its own (a bare Ctrl/Shift/Alt/Super press or release, with no accompanying character).

Only delivered when the Kitty keyboard protocol is active and RunConfig::report_all_keys(true) was set, on a supporting terminal (kitty, Ghostty, WezTerm). Most terminals never emit these, so handlers must treat them as optional.

Since 0.21.0.

Trait Implementations

impl Clone for KeyCode

fn clone(&self) -> KeyCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyCode

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

Formats the value using the given formatter.

impl Eq for KeyCode

impl PartialEq for KeyCode

fn eq(&self, other: &KeyCode) -> 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 StructuralPartialEq for KeyCode