keytap 0.2.0

Cross-platform, observe-only global keyboard taps with left/right modifier fidelity and clean shutdown
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

//! keytap — cross-platform, observe-only global keyboard taps.
//!
//! See `DESIGN.md` in the repository root for the full architecture.
//!
//! ```no_run
//! use keytap::{Tap, EventKind, Key};
//!
//! # fn main() -> Result<(), keytap::Error> {
//! let tap = Tap::new()?;
//! for event in tap.iter() {
//!     if let EventKind::KeyDown(Key::MetaRight) = event.kind {
//!         println!("Right-⌘ pressed");
//!     }
//! }
//! # Ok(()) }
//! ```

#![warn(missing_debug_implementations)]
#![allow(dead_code)] // scaffolding — impls land in subsequent commits

pub use crossbeam_channel::{RecvError, RecvTimeoutError, TryRecvError};

mod error;
mod event;
mod key;
mod platform;
mod tap;

#[cfg(feature = "chord")]
pub mod chord;

pub use error::Error;
pub use event::{Event, EventKind};
pub use key::{Key, RawCode};
pub use tap::{Tap, TapBuilder, TapIter};