Enum rustyline::KeyPress

#[non_exhaustive]
pub enum KeyPress {
    UnknownEscSeq,
    Backspace,
    BackTab,
    BracketedPasteStart,
    BracketedPasteEnd,
    Char(char),
    ControlDown,
    ControlLeft,
    ControlRight,
    ControlUp,
    Ctrl(char),
    Delete,
    Down,
    End,
    Enter,
    Esc,
    F(u8),
    Home,
    Insert,
    Left,
    Meta(char),
    Null,
    PageDown,
    PageUp,
    Right,
    ShiftDown,
    ShiftLeft,
    ShiftRight,
    ShiftUp,
    Tab,
    Up,
}

Input key pressed

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnknownEscSeq

Unsupported escape sequence (on unix platform)

Backspace

⌫ or KeyPress::Ctrl('H')

BackTab

⇤ (usually Shift-Tab)

BracketedPasteStart

Paste (on unix platform)

BracketedPasteEnd

Paste (on unix platform)

Char(char)

Tuple Fields

0: char

Single char

ControlDown

Ctrl-↓

ControlLeft

Ctrl-←

ControlRight

Ctrl-→

ControlUp

Ctrl-↑

Ctrl(char)

Tuple Fields

0: char

Ctrl-char

Delete

⌦

Down

↓ arrow key

End

⇲

Enter

↵ or KeyPress::Ctrl('M')

Esc

Escape or KeyPress::Ctrl('[')

F(u8)

Tuple Fields

0: u8

Function key

Home

⇱

Insert

Insert key

Left

← arrow key

Meta(char)

Tuple Fields

0: char

Escape-char or Alt-char

Null

KeyPress::Char('\0')

PageDown

⇟

PageUp

⇞

Right

→ arrow key

ShiftDown

Shift-↓

ShiftLeft

Shift-←

ShiftRight

Shift-→

ShiftUp

Shift-↑

Tab

⇥ or KeyPress::Ctrl('I')

Up

↑ arrow key

Trait Implementations

impl Clone for KeyPress

fn clone(&self) -> KeyPress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPress

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

Formats the value using the given formatter.

impl Hash for KeyPress

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<KeyPress> for KeyPress

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

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

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

This method tests for !=.

impl Copy for KeyPress

impl Eq for KeyPress

impl StructuralEq for KeyPress

impl StructuralPartialEq for KeyPress