std::option_env - Rust
Description: API documentation for the Rust `option_env` macro in crate `std`.
Keywords: rust, rustlang, rust-lang, option_env

# Macro std::option_env 1.0.0 [−] [src]

    macro_rules! option_env {
        ($name:expr) => { ... };
    }

Optionally inspect an environment variable at compile time.

If the named environment variable is present at compile time, this will expand into an expression of type `Option<&'static str>` whose value is `Some` of the value of the environment variable. If the environment variable is not present, then this will expand to `None`. See `Option<T>` for more information on this type.

A compile time error is never emitted when using this macro regardless of whether the environment variable is present or not.

# Examples

    let key: Option<&'static str> = option_env!("SECRET_KEY");
    println!("the secret key might be: {:?}", key);Run

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)