keymap 1.0.0-rc.5

A lightweight key mapping library with compile-time validated derive macros and declarative configuration for multiple backends.
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
39
40

#[path = "./backend/mod.rs"]
mod backend;

#[path = "./action.rs"]
mod action;

use crate::backend::{print, quit, run};
use action::Action;
use keymap::{DerivedConfig, KeyMapConfig};

// In this example, we showcase Key Group Capturing using .get_bound()
// The Action::Shoot(char) variant is mapped to @any in action.rs.
pub(crate) const CONFIG: &str = r#"
Jump = { keys = ["j"], description = "Jump!" }
"#;

fn main() -> std::io::Result<()> {
    println!("# Example: Key Group Capturing using .get_bound()");
    println!("- Press any key to see it captured by Action::Shoot(char)");
    println!("- Press 'j' to see Action::Jump (unit variant)");
    println!("- Press 'q' or 'esc' to quit");

    let config: DerivedConfig<Action> = toml::from_str(CONFIG).unwrap();

    run(|key| match config.get_bound(&key) {
        Some(action) => match action {
            Action::Quit => quit("quit!"),
            // This is matched via @any and the char is dynamically bound
            Action::Shoot(c) => print(&format!("Matched @any! Captured character: '{c}'")),
            // Standard unit variants work as before
            Action::Jump | Action::Up | Action::Down | Action::Left | Action::Right => {
                print(&format!(
                    "Action: {action:?} (Description: {})",
                    action.keymap_item().description
                ))
            }
        },
        None => print(&format!("Unknown key {key:?}")),
    })
}