Struct Key

pub struct Key {
    pub code: KeyCode,
    pub mods: Option<KeyMod>,
}

Struct representing a Key composed of a KeyCode and KeyMod Note that certain KeyCode + KeyMod combinations are not supported:

• KeyMod::AltCtrlShift and KeyCode::Char(), e.g. KeyCode::Char(‘h’) will report Key { code: Char(’h), mods: KeyMod::CtrlAlt despite the shift key being pressed due to limitations in the terminal API
• KeyMod::AltCtrl and KeyCode::Char(0..=9) are not supported.
• KeyMod::CtrlShift and KeyCode::Char(0..=9) are not supported
• Any modifier keys and Backspace/Tab are not supported, save KeyMod::Shift and KeyCode::Tab which is KeyCode::BackTab
• Shift+Insert is not supported
• Some terminals do not support modifier keys and certain non alpha-numeric keys

Fields

code: KeyCode

any key that could be pressed

mods: Option<KeyMod>

any key modifier ctrl + alt + shift (excluding capital letters w/ shift) that could be pressed.

Implementations

impl Key

pub fn new(key: KeyCode) -> Self

Creates a new Key with no KeyMod

Returns Key

pub fn new_mod(key: KeyCode, mods: KeyMod) -> Self

Creates a new Key with provided KeyMod

Returns Key

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