8 unstable releases (3 breaking)
0.4.1 | Jul 24, 2024 |
---|---|
0.4.0 | Jul 23, 2024 |
0.3.2 | Jun 22, 2024 |
0.2.2 | Apr 17, 2023 |
0.1.0 | Jul 22, 2022 |
#251 in #field
83 downloads per month
Used in 2 crates
(via envir)
11KB
218 lines
These proc macros help you to implement the envir::Serialize
and
envir::Deserialize
traits.
Attributes
By default, these macro use the uppercase field name as environment variable name.
use envir::Deserialize;
#[derive(envir::Deserialize, Debug)]
struct Config {
home: String,
}
let config = Config::from_env();
dbg!(config);
$ cargo run
[src/main.rs:12] config = Ok(
Config {
home: "/home/sanpi",
}
)
Container
prefix
: sets this attributes to add this prefix at the field name.
use envir::Deserialize;
#[derive(envir::Deserialize, Debug)]
#[envir(prefix = "APP_")]
struct Config {
dir: String,
}
let config = Config::from_env();
dbg!(config);
$ export APP_DIR=~/.config/app
$ cargo run
[src/main.rs:12] config = Ok(
Config {
dir: "/home/sanpi/.config/app",
}
)
Field
name
: use this name for the environment variable instead of the name of the field. Ifprefix
is defined, it also prepend to this name;export_with
: use this function to export this field. The given function must be callable asfn (T) -> HashMap<String, String>
;load_with
: use this function to load this field. The given function must be callable asfn (Hashmap<String, String>) -> envir::Result<T>
;noprefix
: doesn’t add theprefix
for this field;nested
: this field should be de/serialized recursively.
use envir::Deserialize;
#[derive(envir::Deserialize, Debug)]
#[envir(prefix = "APP_")]
struct Config {
dir: String,
}
let config = Config::from_env();
dbg!(config);
$ export APP_DIR=~/.config/app
$ cargo run
[src/main.rs:12] config = Ok(
Config {
dir: "/home/sanpi/.config/app",
}
)
Dependencies
~0.6–1MB
~23K SLoC