#configuration #environment #env #settings #source #format

twelf

Twelf is a configuration solution for Rust including 12-Factor support. It is designed with layers in order to configure different sources and formats to build your configuration. The main goal is to be very simple using a proc macro.

24 releases (14 breaking)

0.15.0 Mar 11, 2024
0.13.0 Dec 13, 2023
0.12.0 Jun 26, 2023
0.10.0 Feb 7, 2023
0.1.2 Nov 11, 2020

#16 in Configuration

Download history 491/week @ 2024-01-30 601/week @ 2024-02-06 1046/week @ 2024-02-13 986/week @ 2024-02-20 918/week @ 2024-02-27 1112/week @ 2024-03-05 1024/week @ 2024-03-12 975/week @ 2024-03-19 737/week @ 2024-03-26 1158/week @ 2024-04-02 617/week @ 2024-04-09 1103/week @ 2024-04-16 808/week @ 2024-04-23 451/week @ 2024-04-30 731/week @ 2024-05-07 800/week @ 2024-05-14

3,065 downloads per month
Used in 11 crates (5 directly)

MIT license

69KB
1.5K SLoC

Twelf

Rust Rust Version Docs.rs

Twelf is a configuration solution for Rust including 12-Factor support. It is designed with Layers in order to configure different sources and formats to build your configuration. The main goal is to be very simple using the proc macro twelf::config.

For now it supports :

  • Default settings (inside your codebase with #[serde(default = ...)] coming from serde)
  • Reading from TOML, YAML, JSON, DHALL, INI files
  • Expanding environment variables in your configuration files, for example with a JSON file {"data": ${MY_ENV_VAR:-the_default_value}} example
  • Executing a custom function or closure to supply values via a serde_json::Value
  • Reading from environment variables: it supports HashMap structure with MY_VARIABLE="mykey=myvalue,mykey2=myvalue2" and also array like MY_VARIABLE=first,second thanks to envy.
  • All serde attributes can be used in your struct to customize your configuration as you wish
  • Reading your configuration from your command line built with clap (ATTENTION: if you're using version < v3 use the twelf@0.8 version)

Usage

Simple with JSON and environment variables

use twelf::{config, Layer};

#[config]
#[derive(Default)]
struct Conf {
    test: String,
    another: usize,
}

// Init configuration with layers, each layers override only existing fields
let config = Conf::with_layers(&[
    Layer::Json("conf.json".into()),
    Layer::Env(Some("PREFIX_".to_string()))
]).unwrap();

Example with clap support

use twelf::{config, Layer};

#[config]
struct Conf {
    /// Here is an example of documentation which is displayed in clap
    test: String,
    another: usize,
}

// Will generate global arguments for each of your fields inside your configuration struct
let app = clap::Command::new("test").args(&Conf::clap_args());

// Init configuration with layers, each layers override only existing fields
let config = Conf::with_layers(&[
    Layer::Json("conf.json".into()),
    Layer::Env(Some("PREFIX_".to_string())),
    Layer::Clap(app.get_matches().clone())
]).unwrap();

// ... your application code

Check here for more examples.

Features

Twelf supports crate features, if you only want support for json, env and toml then you just have to add this to your Cargo.toml

twelf = { version = "0.11", default-features = false, features = ["json", "toml", "env"] }

default_trait enables code for a layer that integrate fields derived with the std::default::Default trait.

custom_fn enables code for a layer that allows a custom closure to be executed.

Default features are ["env", "clap", "shellexpand"]

Contributing

Feel free to contribute to the twelf project.

Enable all features when testing changes to the crate:

cargo test --all-features

Alternatives

  • config-rs is almost doing the same except the environment layer (for example we support hashmap and array in environment variables). Also config-rs don't have clap support and it didn't use any proc-macros if you're not very fan of proc-macros.

Dependencies

~2–12MB
~123K SLoC