Struct KeyEvent 

pub struct KeyEvent {
    pub key: Key,
    pub ctrl: bool,
    pub alt: bool,
    pub shift: bool,
}

A Key plus the modifier keys held with it. Named fields (not a bitflag) so a test/keymap-string reader can construct one by hand without needing to know a bit layout.

Fields

key: Key

The key itself.

ctrl: bool

Ctrl held.

alt: bool

Alt held.

shift: bool

Shift held. Deliberately still tracked even for Key::Char (whose case already reflects shift) because some non-alpha chars (arrows, tab) have a distinct shifted meaning (BackTab for Shift+Tab is modeled as its own Key variant by the translator, not via this flag — this flag exists for completeness/testability of a caller that wants to distinguish, e.g., a raw Shift+Left selection chord in a future extension).

Implementations

impl KeyEvent

pub const fn plain(key: Key) -> KeyEvent

A plain, unmodified key — the common case in tests/default bindings.

pub const fn ctrl(key: Key) -> KeyEvent

A Ctrl+key chord.

pub const fn ch(c: char) -> KeyEvent

A plain printable character — shorthand for KeyEvent::plain(Key::Char(c)), the single most common test/keymap construction.

pub fn parse(spec: &str) -> Option<KeyEvent>

Parse the small keymap-string syntax capabilities.tui.keymap.<action> = "<key>" (§3.1) understands: an optional ctrl+/alt+/shift+ prefix (any order, +-joined) followed by either a single character or a named key (enter, esc/escape, backspace, delete/del, tab, up, down, left, right, home, end, pageup/pgup, pagedown/pgdn, f1..f12). Case-insensitive except the bare single-character form, which is taken literally (so "R" and "r" are distinct plain characters, while "Ctrl+R" and "ctrl+r" are the same chord). Returns None for anything it doesn’t recognize — a caller (crate::tui::Keymap::with_overrides) treats an unparseable override as “keep the default”, never a panic or a silently-wrong binding.

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<(), Error>

Formats the value using the given formatter.

impl Eq for KeyEvent

impl Hash for KeyEvent

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 KeyEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyEvent