Enum crossterm_input::KeyEvent

pub enum KeyEvent {
    Backspace,
    Enter,
    Left,
    Right,
    Up,
    Down,
    Home,
    End,
    PageUp,
    PageDown,
    Tab,
    BackTab,
    Delete,
    Insert,
    F(u8),
    Char(char),
    Alt(char),
    Ctrl(char),
    Null,
    Esc,
    CtrlUp,
    CtrlDown,
    CtrlRight,
    CtrlLeft,
    ShiftUp,
    ShiftDown,
    ShiftRight,
    ShiftLeft,
}

Represents a key or a combination of keys.

Variants

Backspace

Backspace key.

Enter

Enter key.

Left

Left arrow key.

Right

Right arrow key.

Up

Up arrow key.

Down

Down arrow key.

Home

Home key.

End

End key.

PageUp

Page up key.

PageDown

Page dow key.

Tab

Tab key.

BackTab

Shift + Tab key.

Delete

Delete key.

Insert

Insert key.

F(u8)

F key.

KeyEvent::F(1) represents F1 key, etc.

Char(char)

A character.

KeyEvent::Char('c') represents c character, etc.

Alt(char)

Alt key + character.

KeyEvent::Alt('c') represents Alt + c, etc.

Ctrl(char)

Ctrl key + character.

KeyEvent::Ctrl('c') represents Ctrl + c, etc.

Null

Null.

Esc

Escape key.

CtrlUp

Ctrl + up arrow key.

CtrlDown

Ctrl + down arrow key.

CtrlRight

Ctrl + right arrow key.

CtrlLeft

Ctrl + left arrow key.

ShiftUp

Shift + up arrow key.

ShiftDown

Shift + down arrow key.

ShiftRight

Shift + right arrow key.

ShiftLeft

Shift + left arrow key.

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Eq for KeyEvent

impl PartialEq<KeyEvent> for KeyEvent

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

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

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

This method tests for !=.

impl PartialOrd<KeyEvent> for KeyEvent

fn partial_cmp(&self, other: &KeyEvent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &KeyEvent) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &KeyEvent) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &KeyEvent) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &KeyEvent) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for KeyEvent

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Hash for KeyEvent

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].