Struct ScopedEnv

pub struct ScopedEnv<T>
where
    T: AsRef<OsStr>,
{ /* private fields */ }

A rust lifetime scope for a set environment variable. When an instance goes out of scope it will automatically cleanup the environment

Implementations

impl<T> ScopedEnv<T>

where T: AsRef<OsStr>,

pub fn set(name: T, value: T) -> Self

Sets the environment variable {name} to {value}. The returned instance should be assigned to a _name binding so that it lasts as long as the current block.

use scoped_env::ScopedEnv;
let c = ScopedEnv::set("HELLO", "WORLD");
assert_eq!(std::env::var(c).unwrap().as_str(), "WORLD");

pub fn remove(name: T) -> Self

Removes the environment variable {name} from the environment of the currently running process. The returned instance should be assigned to a _name binding. The variable value will be restored when the handle goes out of scope.

use scoped_env::ScopedEnv;
std::env::set_var("HELLO", "WORLD");
{
    let c = ScopedEnv::remove("HELLO");
    assert!(std::env::var(c).is_err());
}
assert_eq!(std::env::var("HELLO").unwrap().as_str(), "WORLD");

Trait Implementations

impl<T> AsRef<OsStr> for ScopedEnv<T>

where T: AsRef<OsStr>,

fn as_ref(&self) -> &OsStr

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Drop for ScopedEnv<T>

where T: AsRef<OsStr>,

fn drop(&mut self)

Executes the destructor for this type.