keymap 1.0.0-rc.6

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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

use keymap::Item;

#[cfg(feature = "crossterm")]
#[path = "./crossterm.rs"]
mod crossterm;

#[cfg(feature = "crossterm")]
pub(crate) use crossterm::run;

#[cfg(feature = "crossterm")]
#[allow(unused)]
pub(crate) use ::crossterm::event::KeyEvent as Key;

#[cfg(feature = "termion")]
#[path = "./termion.rs"]
mod termion;

#[cfg(feature = "termion")]
pub(crate) use termion::run;

#[cfg(feature = "termion")]
#[allow(unused)]
pub(crate) use ::termion::event::Key;

#[cfg(not(any(feature = "crossterm", feature = "termion", feature = "wasm")))]
#[path = "./mock.rs"]
mod mock;

#[allow(unused)]
#[cfg(not(any(feature = "crossterm", feature = "termion", feature = "wasm")))]
pub(crate) use mock::{run, Key};

#[allow(dead_code)]
pub(crate) fn print(s: &str) -> bool {
    println!("{s}\r");
    false
}

#[allow(dead_code)]
pub(crate) fn quit(s: &str) -> bool {
    println!("{s}\r");
    true
}

#[allow(dead_code)]
pub(crate) fn print_config<T: std::fmt::Debug>(items: &[(T, Item)]) {
    println!("--- keymap ---");

    items.iter().for_each(|(action, v)| {
        println!(
            "{action:?} = keys: {:?}, description: {}",
            v.keys, v.description
        )
    });

    println!("--------------");
}
#[allow(unused)]
fn main() {}