Struct KeyMap 

pub struct KeyMap {
    pub leader: Option<char>,
    pub leader_timeout_ms: u64,
    pub overlay_error: Option<String>,
    /* private fields */
}

Resolved map: chord -> action (board scope).

Fields

leader: Option<char>

Optional leader character from the overlay.

leader_timeout_ms: u64

How long a leader chord stays armed, in milliseconds.

overlay_error: Option<String>

Why the overlay was refused, when defaults were kept instead.

Implementations

impl KeyMap

pub fn from_defaults() -> Self

Compiled-in chords, no overlay.

pub fn load() -> Self

Load $VISSUE_KEYS or ~/.config/vissue/keys.toml over the defaults.

A missing file keeps the defaults. A broken overlay also keeps the defaults and records the reason in Self::overlay_error.

pub fn get(&self, chord: &str) -> Option<ActionId>

Action bound to chord in board scope, if any.

pub fn help_lines(&self) -> Vec<String>

Help overlay rows: resolved chord, then the dotted action id.

pub fn occupancy(&self) -> Vec<(String, String)>

Every bound chord and the dotted action id it maps to.

pub fn table_lines(&self) -> Vec<String>

One line per action: scope, id, resolved chord.

Trait Implementations

impl Clone for KeyMap

fn clone(&self) -> KeyMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyMap

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

Formats the value using the given formatter.

impl Default for KeyMap

fn default() -> Self

Returns the “default value” for a type.