Enum termion::event::Key

pub enum Key {
    Backspace,
    Left,
    Right,
    Up,
    Down,
    Home,
    End,
    PageUp,
    PageDown,
    BackTab,
    Delete,
    Insert,
    F(u8),
    Char(char),
    Alt(char),
    Ctrl(char),
    Null,
    Esc,
    // some variants omitted
}

A key.

Variants

Backspace

Backspace.

Left

Left arrow.

Right

Right arrow.

Up

Up arrow.

Down

Down arrow.

Home

Home key.

End

End key.

PageUp

Page Up key.

PageDown

Page Down key.

BackTab

Backward Tab key.

Delete

Delete key.

Insert

Insert key.

F

Function keys.

Only function keys 1 through 12 are supported.

Tuple Fields of F

0: u8

Char

Normal character.

Tuple Fields of Char

0: char

Alt

Alt modified character.

Tuple Fields of Alt

0: char

Ctrl

Ctrl modified character.

Note that certain keys may not be modifiable with ctrl, due to limitations of terminals.

Tuple Fields of Ctrl

0: char

Null

Null byte.

Esc

Esc key.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Key> for Key

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for Key

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key