Enum mortal::terminal::Key

pub enum Key {
    Backspace,
    Enter,
    Escape,
    Tab,
    Up,
    Down,
    Left,
    Right,
    Delete,
    Insert,
    Home,
    End,
    PageUp,
    PageDown,
    Char(char),
    Ctrl(char),
    F(u32),
}

Represents a keyboard key press event

Variants

Backspace

Backspace

Enter

Enter

Escape

Escape

Tab

Tab

Up

Up arrow

Down

Down arrow

Left

Left arrow

Right

Right arrow

Delete

Delete

Insert

Insert

Home

Home

End

End

PageUp

PageUp

PageDown

PageDown

Char(char)

Character key

Ctrl(char)

Control character

Notes

The contained char value must always be lowercase; e.g. Ctrl('a') and not Ctrl('A').

On Unix, certain special Key values are represented as control characters; therefore, the following combinations will not generate a Ctrl(_) value:

• Ctrl-I instead generates Tab
• Ctrl-J and Ctrl-M instead generate Enter

F(u32)

Function n key; e.g. F1, F2, ...

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 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 From<char> for Key

fn from(ch: char) -> Key

Performs the conversion.

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

impl StructuralPartialEq for Key