Struct KeyMap 

pub struct KeyMap {
    pub bindings: Vec<Binding>,
}

Declarative key binding map.

Examples

use slt::KeyMap;

let km = KeyMap::new()
    .bind('q', "Quit")
    .bind_code(slt::KeyCode::Up, "Move up")
    .bind_mod('s', slt::KeyModifiers::CONTROL, "Save")
    .bind_hidden('?', "Toggle help");

Fields

bindings: Vec<Binding>

Implementations

impl KeyMap

pub fn new() -> Self

pub fn bind(self, key: char, description: &str) -> Self

Bind a character key.

pub fn bind_code(self, key: KeyCode, description: &str) -> Self

Bind a special key (Enter, Esc, Up, Down, etc.).

pub fn bind_mod(self, key: char, mods: KeyModifiers, description: &str) -> Self

Bind a key with modifier (Ctrl+S, etc.).

pub fn bind_hidden(self, key: char, description: &str) -> Self

Bind but hide from help bar display.

pub fn visible_bindings(&self) -> impl Iterator<Item = &Binding>

Get visible bindings for help bar rendering.

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() -> KeyMap

Returns the “default value” for a type.