#env-var #serde

serde-with-expand-env

Parse environment variables in serde crate using deserialize_with

3 releases (stable)

1.1.0 Feb 21, 2020
1.0.0 Dec 31, 2019
0.1.0 Dec 13, 2019

#1877 in Encoding

Download history 2097/week @ 2026-01-21 1904/week @ 2026-01-28 1399/week @ 2026-02-04 1712/week @ 2026-02-11 3275/week @ 2026-02-18 6629/week @ 2026-02-25 4231/week @ 2026-03-04 4177/week @ 2026-03-11 4179/week @ 2026-03-18 3211/week @ 2026-03-25 1608/week @ 2026-04-01 4219/week @ 2026-04-08 7153/week @ 2026-04-15 3251/week @ 2026-04-22 1845/week @ 2026-04-29 1586/week @ 2026-05-06

14,797 downloads per month
Used in 28 crates (4 directly)

MIT license

7KB

serde-with-expand-env

Build Status MIT licensed

Parse environment variables in serde crate using deserialize_with.

Example:

use std::env;
use serde_json;
use serde::Deserialize;
use serde_with_expand_env::with_expand_envs;

#[derive(Deserialize, Debug)]
struct Test {
    #[serde(deserialize_with="with_expand_envs")]
    number: usize,
    #[serde(deserialize_with="with_expand_envs")]
    string: String,
    #[serde(deserialize_with="with_expand_envs")]
    default: usize,
}

fn main() {
    let serialized = r#"{"number": "$NUMBER",
                         "string": "my string: $STRING",
                         "default": "${DEFAULT:-42}"
                      }"#;

    // No envs set will fail with enviroment variable not found
    assert_eq!(serde_json::from_str::<Test>(&serialized).is_err(), true);

    env::set_var("NUMBER", "42");
    env::set_var("STRING", "hacker");
    let deserialized: Test = serde_json::from_str(&serialized).unwrap();

    assert_eq!(deserialized.number, 42);
    assert_eq!(deserialized.string, "my string: hacker");
    assert_eq!(deserialized.default, 42);

    env::set_var("DEFAULT", "4200");
    let deserialized: Test = serde_json::from_str(&serialized).unwrap();
    assert_eq!(deserialized.default, 4200);

    // Invalid number
    env::set_var("NUMBER", "cuarentaydos");
    env::set_var("STRING", "42");
    assert_eq!(serde_json::from_str::<Test>(&serialized).is_err(), true);
}

more examples in examples

Dependencies

~0.3–1.2MB
~21K SLoC