Enum Key

pub enum Key {
    ArrowDown,
    ArrowLeft,
    ArrowRight,
    ArrowUp,
    Backspace,
    CarriageReturn,
    Char(char),
    End,
    Eof,
    Escape,
    Interrupt,
    Home,
    NewLine,
    PageDown,
    PageUp,
    Tab,
    Unknown(String),
}

Decoded key presses as returned by the console.

Variants

ArrowDown

The cursor down key.

ArrowLeft

The cursor left key.

ArrowRight

The cursor right key.

ArrowUp

The cursor up key.

Backspace

Deletes the previous character.

CarriageReturn

Accepts the current line.

Char(char)

A printable character.

End

The end key or Ctrl-E.

Eof

Indicates a request for termination (e.g. Ctrl-D).

Escape

The escape key.

Interrupt

Indicates a request for interrupt (e.g. Ctrl-C).

Home

The home key or Ctrl-A.

NewLine

Accepts the current line.

PageDown

The Page Down key.

PageUp

The Page Up key.

Tab

The Tab key.

Unknown(String)

An unknown character or sequence. The text describes what went wrong.

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

impl StructuralPartialEq for Key