Adding `fakeenv` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add fakeenv

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

fakeenv = "0.1.0"

The fakeenv library will be automatically available globally. Read the fakeenv library documentation.

Back to the crate overview.

Readme

fakeenv

A simple wrapper of std::env which allows faking the environment.

Example

Using the real environment

use fakeenv::EnvStore;

fn answer(env: &EnvStore) -> i32 {
    env.var("THE_ANSWER").unwrap().parse().unwrap()
}

fn main() {
    std::env::set_var("THE_ANSWER", "42");

    let env = EnvStore::real();
    assert_eq!(answer(&env), 42);
}

Making a fake environment

Fake is only turned on when the fake feature is enabled.

As this is mostly for testing purpose, you might want to enable the feature like this:

[dependencies]
fakeenv = "0.1.0"

[dev-dependencies]
fakeenv = { version = "0.1.0", features = ["fake"] }

Then you can generate a fake environment using EnvStore::fake:

use fakeenv::EnvStore;

fn answer(env: &EnvStore) -> i32 {
    env.var("THE_ANSWER").unwrap().parse().unwrap()
}

fn main() {
    let env = EnvStore::fake();
    env.set_var("THE_ANSWER", "42");
    assert_eq!(answer(&env), 42);
}

Faking user directories

The dirs feature enables faking the dirs functions.

[dependencies]
fakeenv = { version = "0.1.0", features = ["dirs"] }

let env = EnvStore::real();
println!("home directory = {:?}", env.home_dir());

Adding fakeenv library as a dependency

Adding `fakeenv` library as a dependency