Enum rustyline::KeyCode

#[non_exhaustive]
pub enum KeyCode {
    UnknownEscSeq,
    Backspace,
    BackTab,
    BracketedPasteStart,
    BracketedPasteEnd,
    Char(char),
    Delete,
    Down,
    End,
    Enter,
    Esc,
    F(u8),
    Home,
    Insert,
    Left,
    Null,
    PageDown,
    PageUp,
    Right,
    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 Ctrl-H

BackTab

⇤ (usually Shift-Tab)

BracketedPasteStart

Paste (on unix platform)

BracketedPasteEnd

Paste (on unix platform)

Char(char)

Single char

Delete

⌦

Down

↓ arrow key

End

⇲

Enter

↵ or Ctrl-M

Esc

Escape or Ctrl-[

F(u8)

Function key

Home

⇱

Insert

Insert key

Left

← arrow key

Null

\0

PageDown

⇟

PageUp

⇞

Right

→ arrow key

Tab

⇥ or Ctrl-I

Up

↑ arrow key

Trait Implementations

impl Clone for KeyCode

fn clone(&self) -> KeyCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyCode

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

Formats the value using the given formatter.

impl Hash for KeyCode

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 KeyCode

fn eq(&self, other: &KeyCode) -> 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 KeyCode

impl Eq for KeyCode

impl StructuralPartialEq for KeyCode