librsb_sys/lib.rs
1//! FFI interface for librsb.
2//!
3//! # Usage
4//!
5//! In order to conditionally generate bindings and documents, it is suggested to use the following snipplet in `Cargo.toml`.
6//!
7//! ```toml
8//! [dependencies]
9//! librsb-sys = "X.Y.Z" # Fill the version here
10//!
11//! [features]
12//! codegen = ["librsb-sys/codegen"]
13//! doc-only = ["librsb-sys/doc-only"]
14//!
15//! [package.metadata.docs.rs]
16//! features = ["doc-only"]
17//! ```
18//!
19//! # Cargo Features
20//!
21//! - `codegen`
22//!
23//! Generate FFI bindings from header files.
24//!
25//! - `doc-only`
26//!
27//! Disable binding generation and linking.
28//!
29//! # Environment Variables
30//!
31//! The librsb-sys reads the following environment variables.
32//!
33//! - `LIBRSB_PATH`
34//!
35//! The prefix path of the installed librsb library. It defaults to `/usr` if not set.
36//!
37//! - `LIBRSB_INCLUDE`
38//!
39//! The directory to search for C header files. It defaults to `$LIBRSB_PATH/include` if not set.
40//!
41//! - `LIBRSB_LIBRARY`
42//!
43//! The directory to search for library files. It defaults to `$LIBRSB_PATH/lib` if not set.
44
45#![allow(non_upper_case_globals)]
46#![allow(non_camel_case_types)]
47#![allow(non_snake_case)]
48
49mod bindings;
50pub use bindings::*;