bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Fix environment variable getter docs

Browse source
This commit is contained in:
inquisitivecrystal 2021-08-17 00:09:58 -07:00
parent d0a10b2056
commit fdf09130df
1 changed files with 14 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

19
library/std/src/env.rs
View file

@ -185,9 +185,13 @@ impl fmt::Debug for VarsOs {
/// ///
/// # Errors /// # Errors
/// ///
/// Returns `[None]` if the environment variable isn't set. /// This function will return an error if the environment variable isn't set.
/// Returns `[None]` if the environment variable is not valid Unicode. If this is not ///
/// desired, consider using [`var_os`]. /// This function may return an error if the 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
/// not valid Unicode. If this is not desired, consider using [`var_os`].
/// ///
/// # Examples /// # Examples
/// ///
@ -221,8 +225,13 @@ fn _var(key: &OsStr) -> Result<String, VarError> {
/// ///
/// # Errors /// # Errors
/// ///
/// Returns `[None]` if the variable isn't set. /// This function returns an error if the environment variable isn't set.
/// May return `[None]` if the variable value contains the NUL character. ///
/// This function may return an error if the environment variable's name contains
/// the equal sign character (`=`) or the NUL character.
///
/// This function may return an error if the environment variable's value contains
/// the NUL character.
/// ///
/// # Examples /// # Examples
/// ///