Clippy lints / Correctness
Clippy lint · Correctness · checked with Clippy 0.1.99
clippy::option_env_unwrap: this will panic at run-time if the environment variable doesn't exist at compile-time
What it meansChecks for usage of option_env!(...).unwrap() and suggests usage of the env! macro. It is in the correctness group and denied by default (the build fails).
What you see
error: this will panic at run-time if the environment variable doesn't exist at compile-time --> main.rs:3:9 | 3 | let _ = option_env!("HOME").unwrap(); | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: consider using the `env!` macro instead = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#option_env_unwrap = note: `#[deny(clippy::option_env_unwrap)]` on by default
Real output of Clippy 0.1.99 (Rust 1.99) on the example below. Names and line numbers in yours will differ.
Does it matter?
Unwrapping the result of option_env! will panic at run-time if the environment variable doesn’t exist, whereas env! catches it at compile-time.
Code that is almost certainly wrong. Denied by default: the build fails until you fix it or allow it.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
let _ = option_env!("HOME").unwrap();
Write this instead
let _ = env!("HOME");
Turn it off, or on
Allow it where it does not fit your code, as narrowly as you can:
On one item
#[allow(clippy::option_env_unwrap)]
fn my_function() { /* ... */ }Whole crate (Cargo.toml)
[lints.clippy]
option_env_unwrap = "allow"One run
cargo clippy -- -A clippy::option-env-unwrapThe [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.
Clippy's own documentation
What it does
Checks for usage of option_env!(...).unwrap() and
suggests usage of the env! macro.
Why is this bad?
Unwrapping the result of option_env! will panic
at run-time if the environment variable doesn’t exist, whereas env!
catches it at compile-time.
Example
let _ = option_env!("HOME").unwrap();
Is better expressed as:
let _ = env!("HOME");
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- non_octal_unix_permissionsChecks for non-octal values used to set Unix file permissions
- nonsensical_open_optionsChecks for duplicate open options as well as combinations that make no sense
- not_unsafe_ptr_arg_derefthis public function might dereference a raw pointer but is not marked `unsafe`
- out_of_bounds_indexingindex is out of bounds
- panicking_overflow_checksDetects C-style underflow/overflow checks
- panicking_unwrapChecks for calls of unwrap[_err]() that will always fail
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::non_octal_unix_permissionsChecks for non-octal values used to set Unix file permissionsRead it next →Did this answer your question?