1
Fork 0

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).
This commit is contained in:
fleetingbytes 2023-04-03 19:30:20 +02:00 committed by GitHub
parent a450557a54
commit 4cb73cc7d0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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,