#toml #json #yaml-config

figment

A configuration library so con-free, it's unreal

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

Download history 128503/week @ 2025-01-28 144467/week @ 2025-02-04 130624/week @ 2025-02-11 133051/week @ 2025-02-18 147970/week @ 2025-02-25 155169/week @ 2025-03-04 167655/week @ 2025-03-11 155132/week @ 2025-03-18 148880/week @ 2025-03-25 162257/week @ 2025-04-01 156900/week @ 2025-04-08 138373/week @ 2025-04-15 152676/week @ 2025-04-22 135783/week @ 2025-04-29 145021/week @ 2025-05-06 118374/week @ 2025-05-13

572,480 downloads per month
Used in 799 crates (201 directly)

MIT/Apache

305KB
4K SLoC

Figment   ci.svg crates.io docs.rs

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:

  • figment_file_provider_adapter

    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:

Dependencies

~0.1–9.5MB
~109K SLoC