keymap-core 0.1.1

Environment-aware keymap resolution core for terminal UIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! Bind some keys, then resolve inputs. A miss (`None`) is the "pass it through"
//! signal for the same-process case.
//!
//! Run with: `cargo run -p keymap-core --example basic_lookup`

use keymap_core::{Key, KeyInput, Keymap, Modifiers};

#[derive(Clone, Debug, PartialEq)]
enum Action {
    Quit,
    Save,
    SplitPane,
}

fn main() {
    let mut keymap = Keymap::new();
    keymap.bind(KeyInput::new(Key::Char('q'), Modifiers::CTRL), Action::Quit);
    keymap.bind(KeyInput::new(Key::Char('s'), Modifiers::CTRL), Action::Save);
    keymap.bind(
        KeyInput::new(Key::Char('1'), Modifiers::SUPER),
        Action::SplitPane,
    );

    // In a real app these come from the terminal backend (see the `crossterm`
    // feature's `TryFrom<KeyEvent>`); here we construct them directly.
    let inputs = [
        KeyInput::new(Key::Char('q'), Modifiers::CTRL),
        KeyInput::new(Key::Char('1'), Modifiers::SUPER),
        KeyInput::new(Key::Char('x'), Modifiers::NONE),
    ];

    for input in inputs {
        match keymap.get(&input) {
            Some(action) => println!("{input:>8}  ->  consume {action:?}"),
            None => println!("{input:>8}  ->  pass through"),
        }
    }
}