26 releases
0.10.19 | May 17, 2024 |
---|---|
0.10.15 | Mar 16, 2024 |
0.10.13 | Dec 31, 2023 |
0.10.12 | Oct 30, 2023 |
0.9.4 | Oct 30, 2020 |
#3 in Configuration
395,715 downloads per month
Used in 637 crates
(169 directly)
305KB
4K
SLoC
Figment
Figment is a semi-hierarchical configuration library for Rust so con-free, it's unreal.
use serde::Deserialize;
use figment::{Figment, providers::{Format, Toml, Json, Env}};
#[derive(Deserialize)]
struct Package {
name: String,
authors: Vec<String>,
publish: Option<bool>,
// ... and so on ...
}
#[derive(Deserialize)]
struct Config {
package: Package,
rustc: Option<String>,
// ... and so on ...
}
let config: Config = Figment::new()
.merge(Toml::file("Cargo.toml"))
.merge(Env::prefixed("CARGO_"))
.merge(Env::raw().only(&["RUSTC", "RUSTDOC"]))
.join(Json::file("Cargo.json"))
.extract()?;
See the documentation for a detailed usage guide and information.
Usage
Add the following to your Cargo.toml
, enabling the desired built-in providers:
[dependencies]
figment = { version = "0.10", features = ["toml", "env"] }
Third-Party Providers
The following external libraries implement Figment providers:
-
Wraps existing providers. For any key ending in
_FILE
(configurable), emits a key without the_FILE
suffix with a value corresponding to the contents of the file whose path is the original key's value.
Please submit a pull request to add your library to this list.
License
Figment is licensed under either of the following, at your option:
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)
Dependencies
~0.1–9MB
~98K SLoC