tanzim-load 0.5.0

Load configuration bytes from declarative configuration sources
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
60
61
62
63

# tanzim-load

First stage of the tanzim pipeline: reads raw configuration bytes from a declared source.

## The `Load` trait

Implement [`Load`] to add a new source kind. Return one [`Payload`] per config entry found.
Use `Payload::name` for the entry name and `Payload::format` as a hint for the parser stage.

## Built-in loaders

| Module | Feature | Source string |
|--------|---------|---------------|
| `env` | `env` | `env` |
| `file` | `file` | `file` |
| `http` | `http` | `http` |
| `closure` | — | any (user-defined) |

## Example

```rust,no_run
use tanzim_load::{file::File, Load, Source};
use tanzim_source::SourceBuilder;

fn main() -> Result<(), tanzim_load::Error> {
    let loader = File::new();
    let source = SourceBuilder::new()
        .with_source("file")
        .with_resource("/etc/myapp")
        .build()
        .unwrap();
    for payload in loader.load(source)? {
        let payload = payload.normalize();
        println!(
            "resource={:?} name={:?} format={:?} bytes={}",
            payload.source.resource(),
            payload.name,
            payload.format,
            payload.content.len()
        );
    }
    Ok(())
}
```

## Features

| Feature | Enables |
|---------|---------|
| `env` | `env` loader (reads environment variables) |
| `file` | `file` loader (reads from filesystem) |
| `http` | `http` loader (user-provided fetch closure) |
| `logging` | emit log messages via the `log` crate |
| `tracing` | emit trace spans via the `tracing` crate |
| `full` | `env` + `file` + `http` |

Default features: `logging`, `env`.

## Relations

- Depends on [`tanzim-source`](../tanzim-source/) for `Source` and `Options`.
- Produces `Payload` values consumed by [`tanzim-parse`](../tanzim-parse/).
- Full pipeline wired in [`tanzim`](../tanzim/).