Struct Keymap 

pub struct Keymap { /* private fields */ }

A component’s bindings, and the keys rebound on it.

Implementations

impl Keymap

pub fn new(context: impl Into<String>) -> Keymap

An empty keymap whose bindings are in context.

pub fn context(&self) -> &str

The context bind puts bindings in.

pub fn bind( self, action: impl Into<String>, keys: impl IntoIterator<Item = Key>, description: impl Into<String>, ) -> Keymap

Declare that keys do action, described as description.

pub fn add(&mut self, binding: Binding)

Add a binding, in whatever context it has. A binding for an action already declared in that context replaces it.

pub fn extend(&mut self, other: Keymap)

Add every binding of other after this one’s, keeping what other rebound: how a container lists its focused child’s keys with its own.

pub fn rebind(&mut self, action: &str, keys: impl IntoIterator<Item = Key>)

Make keys do action (in this keymap’s context) instead of what was declared or installed. No keys unbinds it.

pub fn rebound( self, action: &str, keys: impl IntoIterator<Item = Key>, ) -> Keymap

Builder form of rebind.

pub fn apply(&mut self, overrides: &Overrides)

Apply overrides on this keymap only, over anything installed.

pub fn lookup(&self, key: Key) -> Option<Binding>

The binding key triggers, if any: see action.

pub fn action(&self, key: Key) -> Option<&str>

The action key triggers, if any: a binding whose keys were rebound (or installed) wins over one with its declared keys, so a key moved onto an action does it even when an earlier action declared it; otherwise the first declared.

pub fn is(&self, key: Key, action: &str) -> bool

Whether key triggers action.

pub fn keys(&self, action: &str) -> Vec<Key>

The keys that trigger action (in any context) now.

pub fn key(&self, action: &str) -> Option<Key>

The first key for action, to show in a hint.

pub fn bindings(&self) -> Vec<Binding>

Every binding, with the keys that do it now.

pub fn declared(&self) -> &[Binding]

Every binding as declared, before rebinding.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

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.

impl Default for Keymap

fn default() -> Self

Returns the “default value” for a type.