Enum Key 

pub enum Key {
    Char(char, Modifiers),
    Code(KeyCode, Modifiers),
}

A portable representation of a key press with modifier state.

Unlike raw crossterm KeyEvent, this type is Hash and Eq, making it suitable for use in maps such as KeybindingsManager.

Variants

Char(char, Modifiers)

A printable character with modifiers.

Code(KeyCode, Modifiers)

A special key code with modifiers.

Implementations

impl Key

pub fn enter() -> Self

Enter / Return with no modifiers.

pub fn left() -> Self

Left arrow with no modifiers.

pub fn right() -> Self

Right arrow with no modifiers.

pub fn up() -> Self

Up arrow with no modifiers.

pub fn down() -> Self

Down arrow with no modifiers.

pub fn backspace() -> Self

Backspace with no modifiers.

pub fn delete() -> Self

Delete with no modifiers.

pub fn home() -> Self

Home with no modifiers.

pub fn end() -> Self

End with no modifiers.

pub fn tab() -> Self

Tab with no modifiers.

pub fn esc() -> Self

Escape with no modifiers.

pub fn ctrl(c: char) -> Self

Character with Control held.

pub fn ctrl_shift(c: char) -> Self

Character with Control + Shift held.

pub fn alt(c: char) -> Self

Character with Alt held.

pub fn char(c: char) -> Self

Character with no modifiers.

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

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