Struct KeyBindingStore 

pub struct KeyBindingStore { /* private fields */ }

Global key table store with tmux-style default snapshots.

Implementations

impl KeyBindingStore

pub fn new() -> Self

Creates an empty key store with no tables.

pub fn with_defaults() -> Result<Self, CommandParseError>

Creates a store populated with the frozen tmux default bindings.

pub fn table(&self, name: &str) -> Option<&KeyBindingTable>

Returns the named table, when present.

pub fn tables(&self) -> impl Iterator<Item = &KeyBindingTable>

Iterates every table in name order.

pub fn get_table( &mut self, name: &str, create: bool, ) -> Option<KeyBindingTableRef>

Finds or creates a table and increments its reference count.

pub fn unref_table(&mut self, name: &str)

Drops one reference from a table and removes it if it is fully empty.

pub fn add_binding( &mut self, table_name: &str, key: KeyCode, note: Option<String>, repeat: bool, commands: Option<ParsedCommands>, ) -> bool

Adds or updates a binding in a table.

pub fn remove_binding(&mut self, table_name: &str, key: KeyCode) -> bool

Removes one active binding from a table.

pub fn reset_binding(&mut self, table_name: &str, key: KeyCode)

Restores one active binding from the default snapshot.

pub fn remove_table(&mut self, table_name: &str) -> bool

Removes every binding from a table.

pub fn reset_table(&mut self, table_name: &str)

Restores every binding in a table from the default snapshot.

pub fn get_binding(&self, table_name: &str, key: KeyCode) -> Option<&KeyBinding>

Returns a binding from the active tree.

pub fn get_default_binding( &self, table_name: &str, key: KeyCode, ) -> Option<&KeyBinding>

Returns a binding from the default snapshot.

pub fn list_bindings( &self, table_name: Option<&str>, sort_order: KeyBindingSortOrder, reversed: bool, ) -> Vec<KeyBindingDisplay>

Returns every binding as display rows sorted for list-keys.

pub fn has_repeat(bindings: &[KeyBindingDisplay]) -> bool

Returns whether any listed binding repeats.

pub fn key_string_width(bindings: &[KeyBindingDisplay]) -> usize

Returns the maximum display width for listed key strings.

pub fn key_table_width(bindings: &[KeyBindingDisplay]) -> usize

Returns the maximum display width for listed table names.

Trait Implementations

impl Clone for KeyBindingStore

fn clone(&self) -> KeyBindingStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyBindingStore

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

Formats the value using the given formatter.

impl Default for KeyBindingStore

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for KeyBindingStore

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

impl StructuralPartialEq for KeyBindingStore