parenv 0.1.1

Environment variable parser with a clap style derive macro and elm style error reporting.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# `parenv`

Environment variable parser with a clap style derive macro and elm style error reporting.

## Installation

```bash
cargo add parenv
```

## Usage

The following demonstrates a simple usage example. `parenv` relies on the `FromStr` trait to parse environment variables into the specified type.
The documentation comment on each field is used as the description for the corresponding environment variable.

```rust
use std::{net::SocketAddr, path::PathBuf};

use parenv::Environment;

#[derive(Debug, Environment)]
struct Env {
    /// The cat
    cat: u8,
    /// The dog
    dog: SocketAddr,
    /// The file
    file: PathBuf,
}

fn main() {
    let env = Env::parse();
    dbg!(env.cat, env.dog, env.file);
}
```

## Demo

[![asciicast](https://asciinema.org/a/689713.svg)](https://asciinema.org/a/689713)