env-inventory 0.2.1

A simple library to load globally available environment variables into a static inventory.
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

# Env-Inventory: Environment Variable Management

`env-inventory` is a Rust library designed to manage and consolidate the process of fetching parameters from the environment. It offers a flexible system to work with environment variables and configurations stored in TOML files.

## Features

- 🌍 **Unified Access**: Streamline the way parameters are fetched from the environment.
- 📁 **TOML Support**: Read and merge configurations directly from TOML files, allowing hierarchical configurations.
- ✅ **Validation**: Validate and ensure that required environment variables are set.

## Getting Started

### Installation

Add `env-inventory` to your `Cargo.toml`:

```toml
[dependencies]
env-inventory = "0.2" # Check crates.io for the latest version
```

### Usage

1. Define required environment variables using the `RequiredVar` struct.

```rust
env_inventory::register!("DATABASE_URL");
```

2. Load and validate environment variables from your TOML configurations:

```rust
let paths = ["path/to/settings.toml"];
env_inventory::load_and_validate_env_vars(&paths, "env").unwrap();
```

## Error Handling

The library provides an `EnvInventoryError` enum to handle various error types such as:
- Reading or parsing the settings file.
- Missing required environment variables.

## Contributing

Pull requests are welcome. Please ensure that your PR passes all the tests before submitting.
Unless otherwise stated, your contributions are assumed to be under the MIT license.

## License

[MIT](LICENSE)