Enum Key

pub enum Key {
    String(String),
    Char(char),
    Bytes(Vec<u8>),
    Byte(u8),
    Ctrl(u8),
    Meta(u8),
    Backspace,
    Escape,
    Up,
    Down,
    Right,
    Left,
    KeypadUp,
    KeypadDown,
    KeypadRight,
    KeypadLeft,
    Home,
    End,
    Insert,
    Delete,
    PageUp,
    PageDown,
    F(u8),
}

Type representing a keypress.

Variants

String(String)

Char(char)

Bytes(Vec<u8>)

Byte(u8)

Ctrl(u8)

The associated value will be a byte corresponding to the lowercase letter for the control code. For instance, ^A will be Ctrl(b'a').

Meta(u8)

Backspace

Escape

Up

Down

Right

Left

KeypadUp

KeypadDown

KeypadRight

KeypadLeft

Home

End

Insert

Delete

PageUp

PageDown

F(u8)

The associated value will be the number corresponding to the F key. For instance, F1 will be F(1).

Implementations

impl Key

pub fn into_bytes(self) -> Vec<u8>

Returns bytes generated by the given key press.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Key

impl StructuralPartialEq for Key