diff options
| author | fleetingbytes <7075397+fleetingbytes@users.noreply.github.com> | 2023-04-03 19:30:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-03 19:30:20 +0200 |
| commit | 4cb73cc7d014d9848c0e00531cbd9dcc561e4253 (patch) | |
| tree | 92ef410e66fd9b5ba5bed4cdd4ca46e8c8d5603d | |
| parent | a450557a54b871ce182900cde3894a3494876e1e (diff) | |
| download | rust-4cb73cc7d014d9848c0e00531cbd9dcc561e4253.tar.gz rust-4cb73cc7d014d9848c0e00531cbd9dcc561e4253.zip | |
Preserve potential mood for equal or NUL sign
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).
| -rw-r--r-- | library/std/src/env.rs | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/library/std/src/env.rs b/library/std/src/env.rs index 1345469d8b3..51e5c60ed29 100644 --- a/library/std/src/env.rs +++ b/library/std/src/env.rs @@ -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, |
