Crates.io | figment_file_provider_adapter |
lib.rs | figment_file_provider_adapter |
version | 0.1.1 |
source | src |
created_at | 2022-09-13 13:40:53.227474 |
updated_at | 2023-10-31 19:59:49.364555 |
description | A Figment provider wrapper to load config values from files |
homepage | https://github.com/nitnelave/figment_file_provider_adapter |
repository | https://github.com/nitnelave/figment_file_provider_adapter |
max_upload_size | |
id | 664588 |
size | 25,604 |
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()?;
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.
Add the following to your Cargo.toml
:
[dependencies]
figment = { version = "0.10" }
figment_file_provider_adapter = { version = "0.1" }
figment_file_provider_adapter is licensed under either of the MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT).