Struct Binding 

pub struct Binding {
    pub key: KeyCode,
    pub modifiers: Option<KeyModifiers>,
    pub display: String,
    pub description: String,
    pub visible: bool,
}

A single key binding with display text and description.

Fields

key: KeyCode

The key code for matching.

modifiers: Option<KeyModifiers>

Optional modifier (Ctrl, Alt, Shift).

display: String

Display text shown in help bar (e.g., “q”, “Ctrl+S”, “↑”).

description: String

Description of what this binding does.

visible: bool

Whether to show in help bar.

Implementations

impl Binding

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

Returns true if key is a press of this binding’s registered chord.

This is the dispatch primitive that mirrors bubbletea’s key.Matches: a KeyEvent matches when it is a press (releases and repeats never match), its KeyCode equals Binding::key, and its modifiers satisfy Binding::modifiers:

• modifiers: None requires that no modifiers are held (so a plain q binding does not fire on Ctrl+q).
• modifiers: Some(mods) requires that at least every modifier in mods is held, matching the lenient semantics of Context::key_mod.

Examples

use slt::{Event, KeyCode, KeyMap, KeyModifiers};

let km = KeyMap::new().bind('q', "Quit");
let binding = &km.bindings[0];

let Event::Key(quit) = Event::key_char('q') else { unreachable!() };
assert!(binding.matches(&quit));

// A plain binding ignores modified presses of the same key.
let Event::Key(ctrl_q) = Event::key_ctrl('q') else { unreachable!() };
assert!(!binding.matches(&ctrl_q));

// A different key never matches.
let Event::Key(other) = Event::key_char('x') else { unreachable!() };
assert!(!binding.matches(&other));

// Modifier bindings use `contains` semantics.
let save = KeyMap::new().bind_mod('s', KeyModifiers::CONTROL, "Save");
let Event::Key(ctrl_s) =
    Event::key_mod(KeyCode::Char('s'), KeyModifiers::CONTROL)
else {
    unreachable!()
};
assert!(save.bindings[0].matches(&ctrl_s));

Trait Implementations

impl Clone for Binding

fn clone(&self) -> Binding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Binding

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

Formats the value using the given formatter.