needs_env_var 1.1.0

Skip compilation if environment variable is missing
Documentation
  • Coverage
  • 50%
    1 out of 2 items documented0 out of 1 items with examples
  • Size
  • Source code size: 4.59 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 240.59 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 2s Average build duration of successful builds.
  • all releases: 2s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • HerrMuellerluedenscheid/needs_env_var
    3 2 1
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • HerrMuellerluedenscheid

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.