Struct KeyChord 

pub struct KeyChord {
    pub code: KeyCode,
    pub mods: KeyModifiers,
}

A normalized key + modifier combination.

Fields

code: KeyCode

The key code.

mods: KeyModifiers

The active modifiers (after normalization).

Implementations

impl KeyChord

pub fn key(code: KeyCode) -> KeyChord

A chord with no modifiers.

pub fn ctrl(c: char) -> KeyChord

A Ctrl+character chord.

pub fn normalized(code: KeyCode, mods: KeyModifiers) -> KeyChord

Builds a normalized chord from a key code and modifiers.

pub fn from_event(ev: KeyEvent) -> KeyChord

Normalizes a terminal key event into a chord for lookup.

pub fn parse(s: &str) -> Option<KeyChord>

Parses a key string such as ctrl+u, alt+enter, shift+tab, f5, or q. Returns None for malformed strings.

pub fn render(&self) -> String

Renders this chord back to a key string (inverse of KeyChord::parse).

pub fn display(&self) -> String

Renders this chord for on-screen hints and the help overlay: terminal-pretty (↑, Enter, Shift+Tab, Ctrl-S, plain letters). Distinct from KeyChord::render, which produces the lowercase ctrl+u config format that round-trips through KeyChord::parse.

Trait Implementations

impl Clone for KeyChord

fn clone(&self) -> KeyChord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyChord

impl Debug for KeyChord

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

Formats the value using the given formatter.

impl Eq for KeyChord

impl Hash for KeyChord

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 KeyChord

fn eq(&self, other: &KeyChord) -> 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 StructuralPartialEq for KeyChord