This repository has been archived on 2024-07-25. You can view files and clone it, but cannot push or open issues or pull requests.
enve/README.md

70 lines
1.9 KiB
Markdown
Raw Normal View History

2022-07-22 15:05:10 +03:00
# enve
2022-07-18 14:36:24 +03:00
2022-07-24 19:03:52 +03:00
[![Crates.io](https://img.shields.io/crates/v/enve?style=flat-square)](https://crates.io/crates/enve)
2022-07-27 12:32:29 +03:00
[![docs.rs](https://img.shields.io/docsrs/enve?style=flat-square)](https://docs.rs/enve)
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/pleshevskiy/enve/CI?label=tests&logo=github&style=flat-square)](https://github.com/pleshevskiy/enve/actions/workflows/ci.yml)
2022-07-27 18:52:59 +03:00
![The MSRV](https://img.shields.io/badge/MSRV-1.59.0-red.svg)
2022-07-27 12:32:29 +03:00
```toml
[dependencies]
2022-07-27 18:52:59 +03:00
enve = "0.2"
2022-07-27 12:32:29 +03:00
```
2019-12-24 19:37:55 +03:00
2022-07-24 18:53:04 +03:00
`enve` helps you work with environment variables and convert it to **any type**
using only **type annotations**.
2019-12-23 15:24:36 +03:00
2022-07-24 18:53:04 +03:00
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.
2020-01-10 08:23:06 +03:00
2022-07-27 12:35:38 +03:00
## [Documentation](https://docs.rs/enve)
2022-07-27 12:32:29 +03:00
Look at the [examples] to see the power!
[examples]: https://github.com/pleshevskiy/enve/tree/main/examples
## Usage
2022-07-24 18:53:04 +03:00
```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(())
}
```
2020-01-10 08:23:06 +03:00
2022-07-27 12:32:29 +03:00
## Contact Us
2020-03-12 23:20:34 +03:00
2022-07-27 12:32:29 +03:00
Join us in:
2020-03-12 23:20:34 +03:00
2022-07-27 12:32:29 +03:00
[![Matrix](https://img.shields.io/badge/matrix-%23enve_team:matrix.org-blueviolet.svg?style=flat-square)](https://matrix.to/#/#enve_team:matrix.org)
2020-03-12 23:20:34 +03:00
2019-12-24 19:37:55 +03:00
## License
2022-07-24 18:53:04 +03:00
**MIT**. See [LICENSE](https://github.com/pleshevskiy/estring/LICENSE) to see
the full text.
2019-12-24 19:37:55 +03:00
## Contributors
2022-07-18 14:36:24 +03:00
[pleshevskiy](https://github.com/pleshevskiy) (Dmitriy Pleshevskiy) creator,
maintainer.