runi-core 0.1.1

Runi core library — foundation types plus a feature-gated bundle that re-exports runi-log and runi-cli
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

//! Runi core library.
//!
//! `runi-core` hosts the foundation types shared across the Runi
//! workspace (`Error`, `Result`, `Config`, `str_util`) and also acts as
//! a feature-gated bundle that re-exports the other Runi sub-crates so
//! most callers only need a single dependency.
//!
//! ## Recommended: alias to `runi`
//!
//! The plain `runi` name on crates.io is held by an unrelated project,
//! so this crate ships as `runi-core`. Cargo lets each consumer rename
//! a dependency at the call site with the `package` key, which gives
//! you the clean `runi::` namespace without waiting on a name
//! transfer:
//!
//! ```toml
//! [dependencies]
//! runi = { package = "runi-core", version = "0.1" }                          # + logging (default)
//! runi = { package = "runi-core", version = "0.1", features = ["cli"] }     # + cli helpers
//! runi = { package = "runi-core", version = "0.1", default-features = false } # foundation only
//! ```
//!
//! ```ignore
//! use runi::{Error, Result};
//! use runi::log;
//! use runi::cli::Tint;
//! ```
//!
//! If you prefer, you can also depend on `runi-core` directly and
//! import as `runi_core::…`.
//!
//! ## Bundle layout
//!
//! - [`runi_log`] is re-exported as [`log`] when the `log` feature is
//!   enabled (on by default).
//! - [`runi_cli`] is re-exported as [`cli`] when the `cli` feature is
//!   enabled.
//!
//! The bundle role follows the pattern from
//! [`wvlet/uni`](https://github.com/wvlet/uni).

pub mod config;
pub mod error;
pub mod str_util;

pub use config::Config;
pub use error::{Error, Result};

#[cfg(feature = "log")]
pub use runi_log as log;

#[cfg(feature = "cli")]
pub use runi_cli as cli;