Skip to content

Commit

Permalink
Preserve potential mood for equal or NUL sign
Browse files Browse the repository at this point in the history
Original `var_os` description said that it _may_ return an error if the value contains `=` or NUL. Let's make no promises on the `None` return value in these situation either, keep it in the [potential mood](https://en.wikipedia.org/wiki/Grammatical_mood#Potential).
  • Loading branch information
fleetingbytes authored Apr 3, 2023
1 parent a450557 commit 4cb73cc
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions library/std/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -236,11 +236,9 @@ fn _var(key: &OsStr) -> Result<String, VarError> {
}

/// Fetches the environment variable `key` from the current process, returning
/// [`None`] in the following situations:
///
/// - the environment variable isn't set
/// - the environment variable's name contains
/// the equal sign character (`=`) or the NUL character
/// [`None`] if the environment variable isn't set. It may return `None` also
/// if the environment variable's name contains
/// the equal sign character (`=`) or the NUL character.
///
/// Note that the method will not check if the environment variable
/// is valid Unicode. If you want to have an error on invalid UTF-8,
Expand Down

0 comments on commit 4cb73cc

Please sign in to comment.