2 releases

0.1.1 Oct 31, 2023
0.1.0 Sep 13, 2022

#447 in Configuration

Download history 85/week @ 2024-06-06 105/week @ 2024-06-13 51/week @ 2024-06-20 96/week @ 2024-06-27 64/week @ 2024-07-04 63/week @ 2024-07-11 98/week @ 2024-07-18 56/week @ 2024-07-25 77/week @ 2024-08-01 64/week @ 2024-08-08 91/week @ 2024-08-15 142/week @ 2024-08-22 119/week @ 2024-08-29 180/week @ 2024-09-05 110/week @ 2024-09-12 117/week @ 2024-09-19

539 downloads per month

MIT license

26KB
388 lines

Figment File Provider Adapter   ci.svg crates.io docs.rs

Figment provider for optionally file-based config values, working with any provider.

use serde::Deserialize;
use figment::{Figment, providers::{Env, Format, Toml}};
use figment_file_provider_adapter::FileAdapter;

#[derive(Deserialize)]
struct Config {
  frobnicate: String,
  foo: u64,
}

let config: Config = Figment::new()
    .merge(FileAdapter::wrap(Env::prefixed("APP_")))
    .merge(FileAdapter::wrap(Toml::file("config.toml")))
    .extract()?;

Overview

This crate contains the FileAdapter provider for Figment, to allow loading configuration values from either direct values or files. It wraps around an existing provider, and for every key that ends in "_FILE" it replaces the value with reading the file mentioned. This is especially useful for secret management in combination with containers.

For instance, to pass an API key to the configuration, you could use either the config value API_KEY=abc123deadbeef, or you could write that API key to a file /secrets/api_key and pass the config value API_KEY_FILE=/secrets/api_key.

See the documentation for a detailed usage guide and more information.

Usage

Add the following to your Cargo.toml:

[dependencies]
figment = { version = "0.10" }
figment_file_provider_adapter = { version = "0.1" }

License

figment_file_provider_adapter is licensed under either of the MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT).

Dependencies

~0.9–1.5MB
~31K SLoC