byteplug 0.0.1

Minimalistic Multimedia Library
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

// Copyright (c) 2020 - Jonathan De Wachter
//
// This source file is part of the Byteplug framework which is released under the MIT license.
// Please refer to the LICENSE file that can be found at the root of the project directory.
//
// Written by Jonathan De Wachter <dewachter.jonathan@gmail.com>, January 2020

//! # Give access to the real-time state of the keyboard.
//!
//! Additional documentation is to be written here.

use std::collections::HashMap;

/// # Brief description.
///
/// The **Component struct** is not documented yet. Pull requests are welcome.
///
pub enum Direction {
    Left, Right, Up, Down
}

/// # An enumeration of the keyboard keys.
///
/// Long description.
///
pub enum Key {
    /// A letter key (A, B, C, ... up to Z)
    Letter(char),
    /// A number key (0, 1, 2, ... up to 9)
    Number(u8),

    /// The escape key
    Escape,
    /// A function key (F1, F2, F3, ... up to F24)
    Function(u8),

    /// The control key (left or right)
    Control {
        /// Left or right version of the key indicator
        left: bool
    },
    /// The shift key (left or right)
    Shift {
        /// Left or right version of the key indicator
        left: bool
    },
    /// The alternate key (left or right)
    Alternate {
        /// Left or right version of the key indicator
        left: bool
    },
    /// The OS-specific key (named either 'Windows' or 'Command')
    System,

    /// One of the arrow key
    Arrow {
        /// The direction of the arrow (left, right, up or down)
        direction: Direction
    },

    /// The ; key
    Semilicon,
    /// The , key
    Comma,
    /// The . key
    Period,
    /// The ' key
    Quote,
    /// The / key
    Slash,
    /// The \ key
    Backslash,
    /// The ~ key
    Tilde,
    /// The = key
    Equal,
    /// The - key
    Hyphen,
    /// The space key
    Space,
    /// The enter/return key
    Enter,
    /// The backspace key
    Backspace,
    /// The tabulation key
    Tab,
    /// The page up key
    PageUp,
    /// The page down key
    PageDown,
    /// The left bracket key
    LeftBracket,
    /// The right bracket key
    RightBracket,

    /// The menu key
    Menu,
    /// The end key
    End,
    /// The home key
    Home,
    /// The insert key
    Insert,
    /// The delete key
    Delete,
    /// The pause key
    Pause,

    /// A numpad number key (0, 1, 2, ... up to 9)
    Numpad(u8),
    /// The + key
    Add,
    /// The - key
    Subtract,
    /// The * key
    Multiply,
    /// The / key
    Divide,

    /// An unknown key (with its OS-specific identifier)
    Unknown(u32)
}

/// # Brief description.
///
/// Long description.
///
pub struct Modifiers {
  pub control: bool,
  pub shift: bool,
  pub alternate: bool,
  pub system: bool
}

/// # Brief description.
///
/// Long description.
///
pub struct Keyboard {
    pressed_keys: HashMap<Key, ()>
}

impl Keyboard {
    /// Brief description.
    ///
    /// Long description.
    ///
    pub fn is_key_pressed(&self) -> bool {
        false
    }

    /// Brief description.
    ///
    /// Long description.
    ///
    pub fn is_connected() -> bool {
        false
    }
}