Enum Key

#[non_exhaustive]
pub enum Key {
    Char(char),
    Function(u8),
    Left,
    Right,
    Up,
    Down,
    PageUp,
    PageDown,
    Home,
    End,
    Insert,
    Enter,
    Delete,
    Backspace,
    Escape,
    Tab,
}

A keyboard key

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.

Char(char)

Function(u8)

A function key, like F1 or F5

Left

Left arrow

Right

Right arrow

Up

Up arrow

Down

Down arrow

PageUp

Page up

PageDown

Page down

Home

Home

End

End

Insert

Insert

Enter

Enter

Delete

Delete

Backspace

Backspace

Escape

Escape

Tab

Tab

Implementations

impl Key

pub const fn is_char(&self, ch: char) -> bool

pub fn to_ascii_uppercase(&self) -> Option<Self>

pub fn to_ascii_lowercase(&self) -> Option<Self>

pub const fn is_ascii_uppercase(&self) -> bool

pub const fn is_ascii_lowercase(&self) -> bool

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 From<Key> for Keybind

fn from(value: Key) -> Self

Converts to this type from the input type.

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

impl Eq for Key

impl StructuralPartialEq for Key