envmnt

Environment variables utility functions.

• Overview
• Usage
• Installation
• API Documentation
• Contributing
• Release History
• License

Overview

This library has many helper functions to access/modify/check environment variables.

Usage

Simply include the library and invoke the various utility functions, for example:

Get/Set/Remove environment variables

extern crate envmnt;

fn main() {
    if !envmnt::exists("MY_ENV_VAR") {
        envmnt::set("MY_ENV_VAR", "SOME VALUE");
    }

    let mut value = envmnt::get_or("MY_ENV_VAR", "DEFAULT_VALUE");
    println!("Env Value: {}", &value);

    value = envmnt::get_or_panic("MY_ENV_VAR");

    let pre_value = envmnt::get_set("MY_ENV_VAR", "SOME NEW VALUE");

    let value = envmnt::get_or("MY_ENV_VAR", "DEFAULT_VALUE");
    println!("New Env Value: {}", &value);
    println!("Previous Env Value: {:?}", &pre_value);

    let all_vars = envmnt::vars(); // returned as Vec<(String, String)>

    for (key, value) in all_vars {
        println!("{}: {}", key, value);
    }
}

Get/Set boolean environment variables and other comparisons

extern crate envmnt;

fn main() {
    envmnt::set_bool("FLAG_VAR", true);
    let flag_value = envmnt::is_or("FLAG_VAR", false);
    println!("Bool Flag: {}", &flag_value);

    let pre_value = envmnt::get_set("MY_ENV_VAR", "SOME NEW VALUE");

    envmnt::set("MY_ENV_VAR", "SOME VALUE");
    let same = envmnt::is_equal("MY_ENV_VAR", "SOME VALUE");
    println!("Value Is Same: {}", &same);
}

Bulk Operations

extern crate envmnt;

fn main() {
    let mut found = envmnt::is_any_exists(&vec![
        "ENV_VAR1",
        "ENV_VAR2",
    ]);

    println!("Any Found: {}", &found);

    found = envmnt::is_all_exists(&vec![
        "ENV_VAR1",
        "ENV_VAR2",
    ]);

    println!("All Found: {}", &found);
}

Installation

In order to use this library, just add it as a dependency:

[dependencies]
envmnt = "*"

API Documentation

See full docs at: API Docs

Contributing

See contributing guide

Release History

v0.3.0 (2019-05-10)

• Added new get_or_panic function #5
• Added new get all args function #6

v0.2.0 (2019-05-09)

• Added bulk variables exists operations #3
• Apis support for OS strings #2
• Fix documentation #1

v0.1.1 (2019-05-08)

• Added 'is_equal' function

v0.1.0 (2019-05-08)

• Initial release

License

Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license.