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
40
41
42
43
44
45
46
47
48

use keybinds::Keybinds;
use serde::Deserialize;
use std::time::Duration;

// Actions triggered by key bindings
#[derive(Deserialize, Debug)]
enum Action {
    OpenFile,
    ExitApp,
}

// Keyboard specific configuration
#[derive(Deserialize)]
struct KeyboardConfig {
    // `Keybinds` implements serde's `Deserialize` to deserialize key bindings from a mapping object
    bindings: Keybinds<Action>,
    // Timeout on waiting for the next input while the matching is ongoing.
    timeout: Option<u64>,
}

// Configuration file format of your application
#[derive(Deserialize)]
struct Config {
    keyboard: KeyboardConfig,
}

fn main() {
    let configuration = r#"
[keyboard]
timeout = 500

[keyboard.bindings]
"Ctrl+Alt+Enter" = "OpenFile"
"Ctrl+x Ctrl+c" = "ExitApp"
"#;

    // Parse the TOML input into the `Config` instance
    let config: Config = toml::from_str(configuration).unwrap();
    let mut keybinds = config.keyboard.bindings;

    // Set the key sequence matching timeout if needed
    if let Some(ms) = config.keyboard.timeout {
        keybinds.set_timeout(Duration::from_millis(ms));
    }

    dbg!(keybinds.as_slice());
    dbg!(keybinds.timeout());
}