keybinds 0.2.0

Platform&Framework-agnostic key binding (keyboard shortcut) dispatcher, parser, and generator written in Safe Rust.
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

use keybinds::{Key, KeyInput, Keybinds};
use std::io::{self, Read};

// Actions dispatched by key bindings
#[derive(Debug)]
enum Action {
    SayHello,
    ExitApp,
}

fn main() -> io::Result<()> {
    // Create a key bindings dispatcher to dispatch actions for upcoming key inputs
    let mut keybinds = Keybinds::default();

    // Register key bindings to dispatch the actions
    keybinds.bind("h e l l o", Action::SayHello).unwrap();
    keybinds.bind("Esc", Action::ExitApp).unwrap();

    println!("Type inputs and send it by hitting Enter key. Send Esc to exit");
    for b in io::stdin().lock().bytes() {
        // Convert your key input into `KeyInput` struct
        let input = match b? {
            b'\x1b' => KeyInput::from(Key::Esc),
            b => KeyInput::from(b as char),
        };
        println!("Key input: {input:?}");

        // Try to dispatch action by `dispatch` method
        if let Some(action) = keybinds.dispatch(input) {
            println!("Dispatched action: {action:?}");
            match action {
                Action::SayHello => println!("Hello!"),
                Action::ExitApp => break,
            }
        }
    }

    Ok(())
}