rmk-types 0.3.0

Common types in RMK
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

//! Keycode definitions including HID keycodes, media keys, and system control keycodes.

mod ascii;
mod consumer;
mod hid;
mod system_control;

pub use ascii::{from_ascii, to_ascii};
pub use consumer::ConsumerKey;
pub use hid::HidKeyCode;
use postcard::experimental::max_size::MaxSize;
use serde::{Deserialize, Serialize};
pub use system_control::SystemControlKey;

/// Key codes which are not in the HID spec, but still commonly used
#[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, PartialOrd, Ord, MaxSize)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[cfg_attr(feature = "_codegen", derive(strum::VariantNames))]
#[non_exhaustive]
#[cfg_attr(feature = "wasm", derive(tsify::Tsify))]
#[cfg_attr(feature = "wasm", tsify(into_wasm_abi, from_wasm_abi))]
pub enum SpecialKey {
    // GraveEscape
    GraveEscape,
    // Repeat
    Repeat,
}

#[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, PartialOrd, Ord, MaxSize)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[non_exhaustive]
#[cfg_attr(feature = "wasm", derive(tsify::Tsify))]
#[cfg_attr(feature = "wasm", tsify(into_wasm_abi, from_wasm_abi))]
pub enum KeyCode {
    Hid(HidKeyCode),
    Consumer(ConsumerKey),
    SystemControl(SystemControlKey),
}

impl KeyCode {
    pub fn is_basic_keyboard_key(&self) -> bool {
        matches!(self,
            KeyCode::Hid(hid) if hid.process_as_consumer().is_none()
                && hid.process_as_system_control().is_none()
                && !hid.is_mouse_key()
        )
    }
}