freedom-config 1.1.0

ATLAS Freedom Configuration
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# Freedom Config

[![Crates.io](https://img.shields.io/crates/v/freedom-config.svg)](https://crates.io/crates/freedom-config)
[![Documentation](https://docs.rs/freedom-config/badge.svg)](https://docs.rs/freedom-config/)

Utilities for creating an ATLAS Freedom configuration

## Usage

The `freedom-config` API provides an easy to use builder type for constructing
the configuration, which can be invoked with the following:

```rust
use freedom_config::{Config, Test};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = Config::builder()
        .environment(Test)
        .key("my_key")
        .secret("my_secret")
        .build()?;
        
    println!("{:?}", config);
    Ok(())
}
```

The builder can also be used to source these items from the environment:

```rust
use freedom_config::Config;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    std::env::set_var(Config::ATLAS_ENV_VAR, "Test");
    std::env::set_var(Config::ATLAS_KEY_VAR, "my_key");
    std::env::set_var(Config::ATLAS_SECRET_VAR, "my_secret");

    let config = Config::builder()
        .environment_from_env()?
        .key_from_env()?
        .secret_from_env()?
        .build()?;
        
    println!("{:?}", config);
    
    Ok(())
}
```

Since this is fairly common, there is also a shorthand for constructing the
config entirely from environment variables

```rust
use freedom_config::Config;

fn main() {
    let config = Config::from_env();
}
```