enve helps you work with environment variables and convert it to any type using only type annotations.
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.
Find a file
2022-07-29 10:12:01 +03:00
.github ci: update the msrv in matrix 2022-07-27 15:50:44 +00:00
.vim refac: improve core design 2022-07-22 13:05:54 +03:00
examples deps: bump estring to 0.3.0 2022-07-29 10:11:59 +03:00
src bump version 2022-07-29 10:12:01 +03:00
.gitignore chore: refac gitignore 2022-07-21 19:09:02 +03:00
Cargo.lock bump version 2022-07-29 10:12:01 +03:00
Cargo.toml bump version 2022-07-29 10:12:01 +03:00
CODE_OF_CONDUCT.md chore: add code of conduct 2021-02-12 01:31:52 +03:00
LICENSE refac: move core to estring crate 2022-07-23 16:21:53 +03:00
README.md bump version 2022-07-29 10:12:01 +03:00

enve

Crates.io docs.rs GitHub Workflow Status The MSRV

[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, so you can easily create your own type.

Documentation

Look at the examples to see the power!

Usage

Basic

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.

use enve::SepVec;

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<MulVec<f32>>>("E")
        .unwrap()
        .iter()
        .map(|m| m.iter().product::<f32>())
        .sum::<f32>();

    assert_eq!(res, 23.0);

    Ok(())
}

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

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

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::<Sum<PlusVec<Product<MulVec<f32>>>>>("E")?
        .agg();

    assert_eq!(res, 23.0);

    Ok(())
}

Contact Us

Join us in:

Matrix

License

MIT. See LICENSE to see the full text.

Contributors

pleshevskiy (Dmitriy Pleshevskiy) creator, maintainer.