makcu 0.3.2

Rust library for controlling MAKCU USB HID interceptor devices
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

//! makcu — Rust library for controlling MAKCU devices.
//!
//! # Quick start
//!
//! ```no_run
//! use makcu::{Device, Button};
//!
//! let dev = Device::connect().expect("MAKCU not found");
//!
//! println!("{}", dev.version().unwrap());
//!
//! dev.button_down(Button::Left).unwrap();
//! dev.move_xy(100, 50).unwrap();
//! dev.button_up(Button::Left).unwrap();
//! ```

mod device;
pub mod error;
pub(crate) mod protocol;
pub(crate) mod transport;
pub mod types;

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

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

/// Per-command timing profiler. Zero-cost when the `profile` feature is disabled.
pub mod profiler;

// -- Public re-exports --

/// Re-export of `crossbeam_channel` so users can type the receivers
/// returned by `button_events()`, `catch_events()`, and `connection_events()`
/// without adding `crossbeam-channel` as a direct dependency.
pub use crossbeam_channel;

pub use device::{Device, DeviceConfig, FireAndForget};
pub use error::{MakcuError, Result};
pub use types::{
    Button, ButtonMask, CatchEvent, ConnectionState, DeviceInfo, LockStates, LockTarget,
};

#[cfg(feature = "async")]
pub use device::{AsyncDevice, AsyncFireAndForget};

#[cfg(feature = "batch")]
pub use batch::BatchBuilder;

#[cfg(all(feature = "batch", feature = "async"))]
pub use batch::AsyncBatchBuilder;

#[cfg(feature = "extras")]
pub use extras::EventHandle;

#[cfg(feature = "mock")]
pub use transport::mock::MockTransport;

/// Library version.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");