Enum termion::event::Key

pub enum Key {
    Backspace,
    Left,
    ShiftLeft,
    AltLeft,
    CtrlLeft,
    Right,
    ShiftRight,
    AltRight,
    CtrlRight,
    Up,
    ShiftUp,
    AltUp,
    CtrlUp,
    Down,
    ShiftDown,
    AltDown,
    CtrlDown,
    Home,
    CtrlHome,
    End,
    CtrlEnd,
    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.

ShiftLeft

Shift Left arrow.

AltLeft

Alt Left arrow.

CtrlLeft

Ctrl Left arrow.

Right

Right arrow.

ShiftRight

Shift Right arrow.

AltRight

Alt Right arrow.

CtrlRight

Ctrl Right arrow.

Up

Up arrow.

ShiftUp

Shift Up arrow.

AltUp

Alt Up arrow.

CtrlUp

Ctrl Up arrow.

Down

Down arrow.

ShiftDown

Shift Down arrow.

AltDown

Alt Down arrow.

CtrlDown

Ctrl Down arrow

Home

Home key.

CtrlHome

Ctrl Home key.

End

End key.

CtrlEnd

Ctrl End key.

PageUp

Page Up key.

PageDown

Page Down key.

BackTab

Backward Tab key.

Delete

Delete key.

Insert

Insert key.

F(u8)

Function keys.

Only function keys 1 through 12 are supported.

Char(char)

Normal character.

Alt(char)

Alt modified character.

Ctrl(char)

Ctrl modified character.

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

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key