Struct KeyBinding 

pub struct KeyBinding { /* private fields */ }

One parsed keyboard shortcut, possibly a multi-key chord (e.g. “ctrl+x b”).

Implementations

impl KeyBinding

pub fn matches_sequence(&self, events: &[KeyEvent]) -> bool

Returns true when this binding matches the given sequence of key events.

pub fn is_chord(&self) -> bool

Returns true if this is a chord (multi-step) binding.

pub fn step_count(&self) -> usize

Returns the number of key steps in this binding.

pub fn key_events(&self) -> Result<Vec<KeyEvent>, KeyEventExpansionError>

Expand this binding into one KeyEvent per chord step.

Combinations that press multiple key codes at once are rejected — send-keys and similar callers need a single discrete event per step.

pub fn canonical(&self) -> &str

Returns the canonical display string for this binding.

pub fn canonical_lowercase(&self) -> String

Returns the canonical display string in lowercase.

pub fn compact_display(&self) -> String

Returns a compact display string with lowercase ordinary keys and modifiers.

Shift-only ASCII letters and US-layout punctuation are shown as the glyph they produce (shift-m → M, shift-/ → ?). Shift remains explicit for special keys and for letters combined with another modifier. This changes display text only; matching and binding identity remain unchanged.

Trait Implementations

impl Clone for KeyBinding

fn clone(&self) -> KeyBinding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyBinding

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

Formats the value using the given formatter.

impl Display for KeyBinding

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

Formats the value using the given formatter.

impl Eq for KeyBinding

impl FromStr for KeyBinding

type Err = KeyBindingParseError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for KeyBinding

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 KeyBinding

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

Equality operator ==.

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

Inequality operator !=.