https://github.com/pleshevskiy/enve

It helps you work with environment variables and convert it to any type using only type annotations.
https://github.com/pleshevskiy/enve

config env environment rust rust-lang web

Last synced: 3 months ago
JSON representation

It helps you work with environment variables and convert it to any type using only type annotations.

• Host: GitHub
• URL: https://github.com/pleshevskiy/enve
• Owner: pleshevskiy
• License: mit
• Archived: true
• Created: 2019-12-22T10:13:28.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2022-12-24T15:35:16.000Z (almost 2 years ago)
• Last Synced: 2024-07-18T08:46:01.400Z (4 months ago)
• Topics: config, env, environment, rust, rust-lang, web
• Language: Rust
• Homepage:
• Size: 215 KB
• Stars: 47
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# enve

[![Crates.io](https://img.shields.io/crates/v/enve?style=flat-square)](https://crates.io/crates/enve)

[![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)

![The MSRV](https://img.shields.io/badge/MSRV-1.59.0-red.svg)

```toml

[dependencies]

enve = "0.3"

```

`enve` helps you work with environment variables and convert it to **any type**

using only **type annotations**.

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.

## [Documentation](https://docs.rs/enve)

Look at the [examples] to see the power!

[examples]: https://github.com/pleshevskiy/enve/tree/main/examples

## Usage

Basic

```rust

fn main() -> Result<(), enve::Error> {

    enve::sset("E", "10");

    let res: f32 = enve::get("E")?;

    println!("result: {}", res);

    Ok(())

}

```

You can use predefined structs like `SepVec` if you enable `structs` feature.

Note: You can use custom types as annotations! Just implement `ParseFragment`.

```rust

use enve::SepVec;

type PlusVec = SepVec;

type MulVec = SepVec;

fn main() -> Result<(), enve::Error> {

    enve::sset("E", "10+5*2+3");

    let res: f32 = enve::get::>>("E")

        .unwrap()

        .iter()

        .map(|m| m.iter().product::())

        .sum::();

    assert_eq!(res, 23.0);

    Ok(())

}

```

You can also use predefined aggregators if you enable `aggs` feature.

```rust

use enve::{SepVec, Product, Sum, estring::Aggregate};

type PlusVec = SepVec;

type MulVec = SepVec;

fn main() -> Result<(), enve::Error> {

    enve::sset("E", "10+5*2+3");

    let res: f32 = enve::get::>>>>("E")?

        .agg();

    assert_eq!(res, 23.0);

    Ok(())

}

```

## Contact Us

Join us in:

[![Matrix](https://img.shields.io/badge/matrix-%23enve_team:matrix.org-blueviolet.svg?style=flat-square)](https://matrix.to/#/#enve_team:matrix.org)

## 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.