openrgb 0.1.2

OpenRGB SDK client
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

//! Client library for [OpenRGB](https://openrgb.org) SDK server.
//!
//! This client is async and requires a [tokio](https://tokio.rs) runtime to run.
//!
//! # Example
//!
//! ```no_run
//! use openrgb::OpenRGB;
//! use std::error::Error;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn Error>> {
//!
//!     // connect to default server at localhost
//!     let client = OpenRGB::connect().await?;
//!
//!     Ok(())
//! }
//! ```
//!
//! See [examples](https://github.com/nicoulaj/openrgb-rs/tree/master/examples), and [OpenRGB] for client API.

#![warn(missing_docs)]
#![deny(rustdoc::broken_intra_doc_links)]

#[macro_use]
extern crate enum_primitive_derive;
extern crate num_traits;

#[doc(inline)]
pub use {
    client::{DEFAULT_ADDR, DEFAULT_PROTOCOL, OpenRGB},
    error::OpenRGBError,
};

mod client;
mod error;
mod protocol;
pub mod data;

#[cfg(test)]
mod tests;