#env-var #env #serde #serde-derive #struct #host #debugging

de_env

Deserialize environment variables into a struct

1 stable release

1.0.0 May 7, 2022
1.0.0-rc.2 May 5, 2022
0.1.0 May 1, 2022

#1754 in Encoding

Download history 16/week @ 2023-12-18 36/week @ 2024-01-29 14/week @ 2024-02-05 30/week @ 2024-02-12 45/week @ 2024-02-19 42/week @ 2024-02-26 55/week @ 2024-03-04 41/week @ 2024-03-11 23/week @ 2024-03-18 11/week @ 2024-03-25 126/week @ 2024-04-01

204 downloads per month

MIT license

25KB
559 lines

de_env helps you easily deserialize environment variables into a struct.

Example

Assuming we have a TIMEOUT, HOST and RETRY environment variable:

#[derive(serde::Deserialize, Debug)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
struct Config {
    timeout: u16,
    host: std::net::IpAddr,
    retry: bool,
}

let config: Config = de_env::from_env()?;

println!("{config:#?}");

lib.rs:

de_env

Deserialize environment variables into a struct.


You may be looking for:

Example

Assuming we have a TIMEOUT and HOST environment variable:

#[derive(serde::Deserialize, Debug)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
struct Config {
    timeout: u16,
    host: std::net::IpAddr,
}

let config: Config = de_env::from_env()?;

println!("{config:#?}");

Supported Primitives

  • String slices
  • Chars
  • Numbers (parsed with their respective FromStr implementations)
  • Booleans (see boolean parsing)

Boolean Parsing

Boolean parsing is case-insensitive.

If the truthy-falsy feature is enabled (default):

  • Truthy values:
    • true or its shorthand t
    • yes or its shorthand y
    • on
    • 1
  • Falsy values:
    • false or its shorthand f
    • no or its shorthand n
    • off
    • 0

If the truthy-falsy feature is disabled, only true and false are considered valid booleans.

Enums

Only unit variants can be deserialized.

Assuming we have a LOG_LEVEL environment variable set to INFO or WARN:

#[derive(serde::Deserialize, Debug)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
enum Level {
    Info,
    Warn
}

#[derive(serde::Deserialize, Debug)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
struct Config {
    log_level: Level,
}

let config: Config = de_env::from_env()?;

println!("{config:#?}");

Unsupported Types

The goal of this crate is to deserialize environment variables into a struct, no other type is supported at top level. Custom types must be able to deserialize from supported primitives.

Dependencies

~110–355KB