Struct KeyCombo 

pub struct KeyCombo {
    pub code: KeyCode,
    pub modifiers: Modifiers,
}

A single key press with its modifiers (Ctrl+x, Shift+Tab, F12, g).

Combos are normalized so that Shift+a, A, and a terminal that reports Char('A') with the Shift bit all compare equal: alphabetic characters are stored lowercase with Modifiers::SHIFT set.

Fields

code: KeyCode

The key.

modifiers: Modifiers

Modifier keys held.

Implementations

impl KeyCombo

pub fn new(code: KeyCode, modifiers: Modifiers) -> Self

Build a normalized combo.

pub fn key(code: KeyCode) -> Self

A combo without modifiers.

pub fn from_event(event: &KeyEvent) -> Self

The combo a key event represents (its kind is ignored).

pub fn matches(&self, event: &KeyEvent) -> bool

Whether event presses this combo (any kind).

Trait Implementations

impl Clone for KeyCombo

fn clone(&self) -> KeyCombo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for KeyCombo

impl Debug for KeyCombo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for KeyCombo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for KeyCombo

impl FromStr for KeyCombo

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse Ctrl+x, Shift+Tab, F12, g, Ctrl++ (the plus key). Modifier names are case-insensitive (Ctrl/Control, Alt/Opt/ Option, Shift, Super/Cmd/Meta/Win).

type Err = KeyParseError

The associated error which can be returned from parsing.

impl Hash for KeyCombo

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 KeyCombo

fn eq(&self, other: &KeyCombo) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KeyCombo