Enum Key 

#[non_exhaustive]
pub enum Key {
    Character(String),
    Enter,
    Tab,
    Space,
    Backspace,
    Delete,
    Escape,
    ArrowLeft,
    ArrowRight,
    ArrowUp,
    ArrowDown,
    Home,
    End,
    PageUp,
    PageDown,
    Function(u8),
    Named(String),
}

A logical key, abstracted away from physical scan codes.

Character carries the produced text for printable keys; named variants cover the common non-printable keys needed for navigation and editing.

The enum is #[non_exhaustive]: new variants added in future releases will deserialise as a serde unknown-field error rather than silently mismatching.

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.

Character(String)

A printable character (already mapped through the active layout/IME).

Enter

Enter / Return.

Tab

Tab.

Space

Space bar.

Backspace

Backspace.

Delete

Delete (forward delete).

Escape

Escape.

ArrowLeft

Left arrow.

ArrowRight

Right arrow.

ArrowUp

Up arrow.

ArrowDown

Down arrow.

Home

Home.

End

End.

PageUp

Page Up.

PageDown

Page Down.

Function(u8)

A function key F1–F24 (the u8 is the number, 1-based).

Named(String)

Any other named key, identified by string (forward-compatible escape).

Implementations

impl Key

pub fn as_text(&self) -> Option<&str>

If this key produces text, return it; otherwise None.

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