Enum KeyCode 

pub enum KeyCode {
    Char(char),
    Enter,
    Tab,
    Escape,
    Backspace,
    Delete,
    Insert,
    Up,
    Down,
    Left,
    Right,
    Home,
    End,
    PageUp,
    PageDown,
    F(u8),
    Unidentified,
}

A single key, crossterm-style: one KeyCode::Char variant absorbs all printable characters instead of per-letter variants.

Variants

Char(char)

Layout-aware produced character ('a', 'A', '?', ' ').

Space is a Char(' '), not a named variant - there is no invisible " " string to confuse with emptiness.

Enter

The Enter / Return key.

Tab

The Tab key.

Escape

The Escape key.

Backspace

The Backspace key.

Delete

The Delete / Forward-delete key.

Insert

The Insert key.

Up

Arrow up.

Down

Arrow down.

Left

Arrow left.

Right

Arrow right.

Home

The Home key.

End

The End key.

PageUp

The Page Up key.

PageDown

The Page Down key.

F(u8)

A function key (F(1) is F1).

Unidentified

A platform key with no mapping. Matches must pass it through, never consume it: it carries no actionable meaning.

Implementations

impl KeyCode

pub fn display(&self) -> String

Canonical display form for kbd chips and logs: arrows as glyphs, well-known names as words, F(n) uppercased, characters verbatim, unidentified keys as ?.

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

impl Debug for KeyCode

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

Formats the value using the given formatter.

impl Display for KeyCode

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

Formats the value using the given formatter.

impl Eq for KeyCode

impl Hash for KeyCode

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