Enum Key 

#[non_exhaustive]
pub enum Key {
    Char(char),
    Enter,
    Escape,
    Backspace,
    Delete,
    Tab,
    BackTab,
    Left,
    Right,
    Up,
    Down,
    Home,
    End,
    PageUp,
    PageDown,
    F(u8),
}

One logical key, independent of any terminal library’s own enum. #[non_exhaustive] so a future key (e.g. a specific F-key past F(12), or a media key) can be added without breaking a downstream match.

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 (already case-correct — Shift is folded in by the translator, not carried as a separate modifier for letters).

Enter

Enter/Return.

Escape

Escape.

Backspace

Backspace.

Delete

Delete (forward-delete).

Tab

Tab.

BackTab

Shift+Tab.

Left

Left arrow.

Right

Right arrow.

Up

Up arrow.

Down

Down arrow.

Home

Home.

End

End.

PageUp

Page Up.

PageDown

Page Down.

F(u8)

A function key, F(1)..=F(12).

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

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