Struct KeyMap 

pub struct KeyMap<A> { /* private fields */ }

A declarative binding map: chords to actions with priorities and contexts. Actions are any Clone type (usually an app enum).

Implementations

impl<A> KeyMap<A>

pub fn new() -> Self

An empty map with default timing.

pub fn with_config(config: KeyMapConfig) -> Self

An empty map with the given timing.

pub fn config(&self) -> &KeyMapConfig

Timing configuration.

pub fn context(&mut self, name: &str) -> ContextId

Intern a context name; the same name always yields the same id.

pub fn context_name(&self, id: ContextId) -> Option<&str>

Name of an interned context.

pub fn bind(&mut self, chord: Chord, action: A) -> BindingId

Bind a chord at Priority::Global with no context.

pub fn bind_in( &mut self, chord: Chord, action: A, priority: Priority, context: Option<ContextId>, ) -> BindingId

Bind a chord with an explicit priority and optional context.

pub fn set_label(&mut self, id: BindingId, label: impl Into<String>) -> bool

Attach a label to a binding; false if the id is unknown.

pub fn unbind(&mut self, id: BindingId) -> Option<Binding<A>>

Remove a binding.

pub fn bindings(&self) -> &[Binding<A>]

All bindings in bind order.

pub fn get(&self, id: BindingId) -> Option<&Binding<A>>

A binding by id.

pub fn len(&self) -> usize

Number of bindings.

pub fn is_empty(&self) -> bool

Whether the map has no bindings.

pub fn lookup(&self, chord: &Chord, active: &[ContextId]) -> Lookup<'_, A>

Resolve chord against the bindings applicable under active contexts: the winning exact binding and how many longer bound chords start with it.

pub fn conflicts(&self) -> ConflictReport

Report shadowed, duplicate, and prefix-colliding bindings.

Trait Implementations

impl<A: Clone> Clone for KeyMap<A>

fn clone(&self) -> KeyMap<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for KeyMap<A>

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

Formats the value using the given formatter.

impl<A> Default for KeyMap<A>

fn default() -> Self

Returns the “default value” for a type.