#serde #environment #env-var #variables #parse #expand #deserialize-with

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

#1372 in Encoding

Download history 1325/week @ 2024-11-16 1425/week @ 2024-11-23 1855/week @ 2024-11-30 1424/week @ 2024-12-07 611/week @ 2024-12-14 363/week @ 2024-12-21 1192/week @ 2024-12-28 1278/week @ 2025-01-04 2485/week @ 2025-01-11 755/week @ 2025-01-18 721/week @ 2025-01-25 1581/week @ 2025-02-01 421/week @ 2025-02-08 1566/week @ 2025-02-15 1621/week @ 2025-02-22 4493/week @ 2025-03-01

8,145 downloads per month
Used in 19 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.4–1.4MB
~26K SLoC