Struct Keymap 

pub struct Keymap { /* private fields */ }

Default shortcuts plus user overrides, indexed for lookup by chord.

Implementations

impl Keymap

pub fn new<'a>( platform: Platform, defaults: impl IntoIterator<Item = (&'a str, Option<&'a str>)>, ) -> Self

A keymap from (command id, default shortcut text) pairs. Commands without a default key (None) are known, so the user can bind them. Unparseable defaults are skipped and listed in Keymap::invalid_defaults.

pub fn from_registry<S: Host>( registry: &Registry<S>, platform: Platform, ) -> Self

The default keymap of a command table.

pub fn platform(&self) -> Platform

pub fn invalid_defaults(&self) -> &[(String, String)]

Default shortcuts that did not parse: (command id, text).

pub fn lookup(&self, chord: &Chord) -> Option<&str>

The command a chord runs (user bindings first, then declaration order).

pub fn commands_for(&self, chord: &Chord) -> Vec<&str>

Every command bound to a chord, in lookup order.

pub fn keys_for(&self, id: &str) -> &[Chord]

The keys that run a command now (its overrides, else its defaults).

pub fn default_keys(&self, id: &str) -> &[Chord]

The default keys of a command.

pub fn knows(&self, id: &str) -> bool

Whether the command is known to this keymap.

pub fn bind(&mut self, id: &str, keys: Vec<Chord>) -> bool

Replace a command’s keys (an empty list unbinds it). Returns false for an unknown command.

pub fn reset(&mut self, id: &str)

Back to the default keys of one command.

pub fn reset_all(&mut self)

pub fn would_conflict(&self, id: &str, chord: &Chord) -> Vec<&str>

Commands other than id that already use chord (to warn before binding).

pub fn conflicts(&self) -> Vec<Conflict>

Every chord claimed by more than one command, sorted by chord.

pub fn overrides(&self) -> Overrides

The overrides, to save in settings.

pub fn apply_overrides(&mut self, overrides: &Overrides) -> usize

Apply saved overrides. Never fails: unknown commands and keys that don’t parse are skipped (their count is returned), and the input is capped.

pub fn apply_overrides_json(&mut self, value: &Value) -> usize

Read overrides from a settings value ({"bindings": {...}}); anything malformed is ignored.

Trait Implementations

impl Clone for Keymap

fn clone(&self) -> Self

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.