https://github.com/roger/serde-with-expand-env

Parse environment variables in serde crate using deserialize_with
https://github.com/roger/serde-with-expand-env

rust serde

Last synced: 3 months ago
JSON representation

Parse environment variables in serde crate using deserialize_with

• Host: GitHub
• URL: https://github.com/roger/serde-with-expand-env
• Owner: Roger
• License: mit
• Created: 2019-12-13T02:14:05.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-27T05:01:16.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T15:21:38.562Z (3 months ago)
• Topics: rust, serde
• Language: Rust
• Homepage:
• Size: 13.7 KB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# serde-with-expand-env

[![Build Status](https://travis-ci.org/Roger/serde-with-expand-env.svg?branch=master)](https://travis-ci.org/Roger/serde-with-expand-env) [![](http://meritbadge.herokuapp.com/serde-with-expand-env)](https://crates.io/crates/serde-with-expand-env) [![](https://docs.rs/serde-with-expand-env/badge.svg)](https://docs.rs/serde-with-expand-env) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

Parse environment variables in [`serde`](https://github.com/serde-rs/serde) crate using `deserialize_with`.

# Example:

```rust

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::(&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::(&serialized).is_err(), true);

}

```

more examples in [examples](examples/)