tmp_env

Crates.iotmp_env
lib.rstmp_env
version0.1.1
sourcesrc
created_at2021-06-09 15:56:56.869205
updated_at2021-06-16 09:37:57.878022
descriptionA crate which lets you create temporary environment and be automatically restored/cleaned when not needed
homepage
repositoryhttps://github.com/bnjjj/tmp_env
max_upload_size
id408217
size11,977
Coenen Benjamin (bnjjj)

documentation

README

tmp_env

Version Documentation

tmp_env is a crate which lets you create temporary environment and be automatically cleaned when not needed.

For example sometimes you need to change the current directory or set environment variables to launch a process but you don't need this temporary environment for the rest of your program. Then you will use tmp_env to create environment variable using tmp_env::set_var instead of std::env::set_var to get from tmp_env::set_var a datastructure which will automatically restore the corresponding environment variable when dropped.

Install

Put this dependency in your Cargo.toml

tmp_env = "0.1"

Usage

  • To temporary change the current directory:
{
    let _tmp_current_dir = tmp_env::set_current_dir("src").expect("should set the new current_dir");
    let current_dir = std::env::current_dir().expect("cannot get current dir from std env");
    assert!(current_dir.ends_with("src"));
}
let current_dir = std::env::current_dir().expect("cannot get current dir from std env");
assert!(!current_dir.ends_with("src"));
  • To temporary set an environment variable:
{
    let _tmp_env = tmp_env::set_var("TEST_TMP_ENV", "myvalue");
    assert_eq!(std::env::var("TEST_TMP_ENV"), Ok(String::from("myvalue")));
}
// Because guard `_tmp_env` is dropped then the environment variable is also automatically unset (not restored because no previous value was set)
assert!(std::env::var("TEST_TMP_ENV").is_err());
  • To temporary create a directory
{
    let tmp_dir = tmp_env::create_temp_dir().expect("cannot create temp dir"); // When tmp_dir is dropped this temporary dir will be removed
    assert!(std::fs::metadata(&*tmp_dir).is_ok());
}
// The temporary directory is now removed
Commit count: 4

cargo fmt