needs_env_var

Crates.ioneeds_env_var
lib.rsneeds_env_var
version1.1.0
sourcesrc
created_at2023-03-25 08:20:07.592901
updated_at2024-09-03 19:11:52.109057
descriptionSkip compilation if environment variable is missing
homepage
repositoryhttps://github.com/HerrMuellerluedenscheid/needs_env_var
max_upload_size
id819998
size4,596
Marius Kriegerowski (HerrMuellerluedenscheid)

documentation

README

Needs environment variable

Skip code (such as a test) at compile time if an environment variable is undefined.

Example

some_test will not be compiled if SOMEENVIRONMENTVARIABLE is not defined:

use needs_env_var::*;

#[needs_env_var(SOMEENVIRONMENTVARIABLE)]
#[test]
fn some_test() {
    assert!(1 == 1);
}

// or if its specified value not matched
#[needs_env_var(SOMEENVIRONMENTVARIABLE = 1)]
#[test]
fn some_test() {
    assert!(1 == 1);
}


#[needs_env_var(SOMEENVIRONMENTVARIABLE=1)]
#[test]
fn some_test() {
    assert!(1 == 1);
}

Note: As needs_env_var is evaluated at compile time you need to force a re-compilation an environment variable is defined after compilation, e.g. with cargo clean.

Commit count: 5

cargo fmt