Struct KeyBinding 

pub struct KeyBinding { /* private fields */ }

One concrete key event that can trigger a TUI action.

Matching via is_press handles exact equality plus compatibility fallbacks for terminals that report uppercase letters without SHIFT and Ctrl keys as raw C0 control characters. This means a binding defined as shift-a will match either Shift+a or plain A, and ctrl-j will match raw LF.

This does not model multi-key chords or partial matches; callers that need sequences must keep that state outside this type.

Implementations

impl KeyBinding

pub const fn new(key: KeyCode, modifiers: KeyModifiers) -> Self

pub fn from_event(event: KeyEvent) -> Self

pub fn is_press(&self, event: KeyEvent) -> bool

pub const fn parts(&self) -> (KeyCode, KeyModifiers)

pub fn display_label(&self) -> String

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 Copy for KeyBinding

impl Debug for KeyBinding

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

Formats the value using the given formatter.

impl Eq for KeyBinding

impl From<&KeyBinding> for Span<'static>

fn from(binding: &KeyBinding) -> Self

Converts to this type from the input type.

impl From<KeyBinding> for Span<'static>

fn from(binding: KeyBinding) -> Self

Converts to this type from the input 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: &KeyBinding) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyBinding