Enum Key

#[non_exhaustive]
pub enum Key {
    Escape,
    Enter,
    Tab,
    Backspace,
    Insert,
    Delete,
    Left,
    Right,
    Up,
    Down,
    PageUp,
    PageDown,
    Home,
    End,
    CapsLock,
    ScrollLock,
    NumLock,
    PrintScreen,
    Pause,
    Menu,
    KeypadBegin,
    F(u8),
    Media(MediaKey),
    Mod(ModifierKey),
    Char(char),
}

A 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.

Escape

Enter

Tab

Backspace

Insert

Delete

Left

Right

Up

Down

PageUp

PageDown

Home

End

CapsLock

ScrollLock

NumLock

PrintScreen

Pause

Menu

KeypadBegin

F(u8)

Media(MediaKey)

Mod(ModifierKey)

Char(char)

Implementations

impl Key

pub fn with_ss3(byte: u8) -> Option<Self>

Get the key corresponding to SS3/CSI-1 and the given byte.

pub fn with_function_key(code: u8) -> Option<Self>

Map a function key code to a key.

For a DECFNK escape sequence, that is, CSI Pcode ; Pmod ~, this method maps the code parameter to a key.

pub fn with_csi_u(code: u16) -> Option<(Self, Modifiers)>

Map the CSI/u key code to a key.

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

impl Eq for Key

impl StructuralPartialEq for Key