Enum Key 

pub enum Key {
    Char(char),
    Backspace,
    Delete,
    Insert,
    Enter,
    Left,
    Right,
    Up,
    Esc,
    Down,
    Home,
    End,
    PageUp,
    PageDown,
    Tab,
    BackTab,
    F(u8),
    Null,
}

Variants

Char(char)

Backspace

Delete

Insert

Enter

Left

Right

Up

Esc

Down

Home

End

PageUp

PageDown

Tab

BackTab

F(u8)

Null

Implementations

impl Key

pub const fn is_char(&self) -> bool

Returns true if the enum is Key::Char otherwise false

pub const fn is_backspace(&self) -> bool

Returns true if the enum is Key::Backspace otherwise false

pub const fn is_delete(&self) -> bool

Returns true if the enum is Key::Delete otherwise false

pub const fn is_insert(&self) -> bool

Returns true if the enum is Key::Insert otherwise false

pub const fn is_enter(&self) -> bool

Returns true if the enum is Key::Enter otherwise false

pub const fn is_left(&self) -> bool

Returns true if the enum is Key::Left otherwise false

pub const fn is_right(&self) -> bool

Returns true if the enum is Key::Right otherwise false

pub const fn is_up(&self) -> bool

Returns true if the enum is Key::Up otherwise false

pub const fn is_esc(&self) -> bool

Returns true if the enum is Key::Esc otherwise false

pub const fn is_down(&self) -> bool

Returns true if the enum is Key::Down otherwise false

pub const fn is_home(&self) -> bool

Returns true if the enum is Key::Home otherwise false

pub const fn is_end(&self) -> bool

Returns true if the enum is Key::End otherwise false

pub const fn is_page_up(&self) -> bool

Returns true if the enum is Key::PageUp otherwise false

pub const fn is_page_down(&self) -> bool

Returns true if the enum is Key::PageDown otherwise false

pub const fn is_tab(&self) -> bool

Returns true if the enum is Key::Tab otherwise false

pub const fn is_back_tab(&self) -> bool

Returns true if the enum is Key::BackTab otherwise false

pub const fn is_f(&self) -> bool

Returns true if the enum is Key::F otherwise false

pub const fn is_null(&self) -> bool

Returns true if the enum is Key::Null otherwise false

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate 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 Hash for Key

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 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 TryFrom<KeyCode> for Key

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(key_code: CrosstermKeyCode) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Key

impl StructuralPartialEq for Key