75 lines
2 KiB
Markdown
75 lines
2 KiB
Markdown
# enve
|
||
|
||
[](https://github.com/pleshevskiy/enve/actions/workflows/ci.yml)
|
||
[](https://github.com/rust-secure-code/safety-dance/)
|
||
[](https://docs.rs/enve)
|
||
[](https://crates.io/crates/enve)
|
||
|
||
|
||
`enve` helps you work with environment variables and convert it to **any type**
|
||
using only **type annotations**.
|
||
|
||
Look at the [examples](https://github.com/pleshevskiy/enve/tree/main/examples)
|
||
to see the power!
|
||
|
||
All standard environment variable types are included, but `enve` under the hood
|
||
uses [estring](https://github.com/pleshevskiy/estring), so you can easily create
|
||
your own type.
|
||
|
||
## Getting started
|
||
|
||
```rust
|
||
use enve::SepVec;
|
||
|
||
type MinusVec<T> = SepVec<T, '-'>;
|
||
type PlusVec<T> = SepVec<T, '+'>;
|
||
type MulVec<T> = SepVec<T, '*'>;
|
||
|
||
fn main() -> Result<(), enve::Error> {
|
||
enve::sset("E", "10+5*2-3");
|
||
|
||
let res: f32 = enve::get::<PlusVec<MinusVec<MulVec<f32>>>>("E")
|
||
.unwrap()
|
||
.iter()
|
||
.map(|p| {
|
||
p.iter()
|
||
.map(|m| m.iter().product::<f32>())
|
||
.reduce(|acc, v| acc - v)
|
||
.unwrap_or_default()
|
||
})
|
||
.sum::<f32>();
|
||
|
||
println!("result: {}", res);
|
||
|
||
Ok(())
|
||
}
|
||
```
|
||
|
||
## Installation
|
||
|
||
The MSRV is 1.51.0
|
||
|
||
Add `enve = { version = "0.1", features = ["prim", "vec"] }` as a dependency in
|
||
`Cargo.toml`.
|
||
|
||
`Cargo.toml` example:
|
||
|
||
```toml
|
||
[package]
|
||
name = "my-crate"
|
||
version = "0.1.0"
|
||
authors = ["Me <user@rust-lang.org>"]
|
||
|
||
[dependencies]
|
||
enve = { version = "0.1", features = ["prim", "vec"] }
|
||
```
|
||
|
||
## License
|
||
|
||
**MIT**. See [LICENSE](https://github.com/pleshevskiy/estring/LICENSE) to see
|
||
the full text.
|
||
|
||
## Contributors
|
||
|
||
[pleshevskiy](https://github.com/pleshevskiy) (Dmitriy Pleshevskiy) – creator,
|
||
maintainer.
|