Struct KeyCombo 

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

A key combination (key + modifiers).

Fields

code: KeyCode

The key code.

modifiers: KeyModifiers

The modifier keys (Ctrl, Shift, Alt).

Implementations

impl KeyCombo

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

Create a new key combination.

pub const fn key(code: KeyCode) -> Self

Create a key combination with no modifiers.

pub const fn ctrl(c: char) -> Self

Create a Ctrl+key combination.

pub const fn alt(c: char) -> Self

Create an Alt+key combination.

pub const fn shift(code: KeyCode) -> Self

Create a Shift+key combination.

pub const fn ctrl_alt(c: char) -> Self

Create a Ctrl+Alt+key combination.

pub const fn ctrl_shift(c: char) -> Self

Create a Ctrl+Shift+key combination.

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

Check if this combo matches a key event.

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 Debug for KeyCombo

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

Formats the value using the given formatter.

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

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 KeyCombo

impl Eq for KeyCombo

impl StructuralPartialEq for KeyCombo