mirror of
https://github.com/rust-lang/rust.git
synced 2025-02-19 18:34:08 +00:00
doc: std::env::var: Returns None for names with '=' or NUL byte
The documentation incorrectly stated that std::env::var could return an error for variable names containing '=' or the NUL byte. Copy the correct documentation from var_os. var_os was fixed in Commit8a7a665
, Pull Request #109894, which closed Issue #109893. This documentation was incorrectly added in commitf2c0f292
, which replaced a panic in var_os by returning None, but documented the change as "May error if ...". Reference the specific error values and link to them.
This commit is contained in:
parent
899eb03926
commit
d5a7c45966
@ -198,13 +198,16 @@ impl fmt::Debug for VarsOs {
|
|||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// This function will return an error if the environment variable isn't set.
|
/// This function returns [`VarError::NotPresent`] if the environment variable
|
||||||
|
/// isn't set.
|
||||||
///
|
///
|
||||||
/// This function may return an error if the environment variable's name contains
|
/// This function may return [`VarError::NotPresent`] if the
|
||||||
/// the equal sign character (`=`) or the NUL character.
|
/// environment variable's name contains the equal sign character (`=`) or the
|
||||||
|
/// NUL character.
|
||||||
///
|
///
|
||||||
/// This function will return an error if the environment variable's value is
|
/// This function will return [`VarError::NotUnicode`] if the environment
|
||||||
/// not valid Unicode. If this is not desired, consider using [`var_os`].
|
/// variable's value is not valid Unicode. If this is not desired, consider
|
||||||
|
/// using [`var_os`].
|
||||||
///
|
///
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
|
Loading…
Reference in New Issue
Block a user