Struct KeyEvent 

pub struct KeyEvent {
    pub chord: KeyChord,
    pub kind: KeyKind,
    pub text: Option<char>,
}

A key event.

Fields

chord: KeyChord

The key and modifiers, normalised for keymap matching: letters are lowercase with shift set when typed uppercase.

kind: KeyKind

Down, repeat or up.

text: Option<char>

The character to insert when typing, if this key produces one.

Implementations

impl KeyEvent

pub fn press(chord: &str) -> Self

A key press from a chord such as "ctrl+s", with the character it types.

Panics

Panics when chord is not a valid chord; meant for tests and fixed bindings.

pub fn from_chord(chord: KeyChord) -> Self

A press of chord; text is derived from plain character and space keys.

pub fn is_plain(&self, key: Key) -> bool

Whether this is a press (not repeat or release) of exactly key with no modifiers.

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyEvent

impl Debug for KeyEvent

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

Formats the value using the given formatter.

impl Eq for KeyEvent

impl PartialEq for KeyEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyEvent