Struct KeyMap 

pub struct KeyMap<A> {
    pub id: String,
    pub bindings: HashMap<Vec<KeyChord>, A>,
}

Fields

id: String

bindings: HashMap<Vec<KeyChord>, A>

Implementations

impl<A> KeyMap<A>

pub fn new(id: impl Into<String>) -> Self

pub fn bind(&mut self, sequence: impl Into<Vec<KeyChord>>, action: A)

pub fn unbind(&mut self, sequence: &[KeyChord]) -> Option<A>

Remove the binding for an exact chord sequence, returning the action it was mapped to (if any). Pair with crate::input::try_parse_binding to drive a remap UI: map.unbind(&try_parse_binding(old)?).

impl<A: PartialEq> KeyMap<A>

pub fn bindings_for(&self, action: &A) -> Vec<&[KeyChord]>

Every chord sequence currently bound to action in this map. Useful for a help screen (“what fires this action?”) or to find what to unbind before rebinding.

pub fn unbind_action(&mut self, action: &A) -> usize

Remove every binding mapped to action, returning how many were removed. Lets a remap UI clear an action’s old keys before assigning new ones, regardless of how many sequences pointed at it.

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.