Enum getch_rs::Key

pub enum Key {
    Null,
    Backspace,
    Delete,
    Esc,
    Up,
    Down,
    Right,
    Left,
    End,
    Home,
    BackTab,
    Insert,
    PageUp,
    PageDown,
    F(u8),
    Char(char),
    Alt(char),
    Ctrl(char),
    Other(Vec<u8>),
}

Keys

Variants

Null

Null byte.

Backspace

Backspace.

Delete

Delete key.

Esc

Esc key.

Up

Up arrow.

Down

Down arrow.

Right

Right arrow.

Left

Left arrow.

End

End key.

Home

Home key.

BackTab

Backward Tab key.

Insert

Insert key.

PageUp

Page Up key.

PageDown

Page Down 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.

Other(Vec<u8>)

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

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

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key