mirror of
https://github.com/rust-lang/rust.git
synced 2025-01-26 14:43:24 +00:00
Rollup merge of #84692 - r00ster91:var-var_os-vars, r=joshtriplett
Link between std::env::{var, var_os} and std::env::{vars, vars_os} In #84551 I linked between `std::env::{args, args_os}` and this PR does the same but for `std::env::{var, var_os}` and `std::env::{vars, vars_os}`. Now all of `std::env::{var, var_os, vars, vars_os, args, args_os}` should each mention their `_os` or non-`_os` equivalent in the docs so that you can easily navigate between them.
This commit is contained in:
commit
6e50ac8a34
@ -124,6 +124,10 @@ pub fn vars() -> Vars {
|
||||
/// variables at the time of this invocation. Modifications to environment
|
||||
/// variables afterwards will not be reflected in the returned iterator.
|
||||
///
|
||||
/// Note that the returned iterator will not check if the environment variables
|
||||
/// are valid Unicode. If you want to panic on invalid UTF-8,
|
||||
/// use the [`vars`] function instead.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
@ -180,8 +184,9 @@ impl fmt::Debug for VarsOs {
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// * Environment variable is not present
|
||||
/// * Environment variable is not valid unicode
|
||||
/// Errors if the environment variable is not present.
|
||||
/// Errors if the environment variable is not valid Unicode. If this is not desired, consider using
|
||||
/// [`var_os`].
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
@ -221,6 +226,10 @@ fn _var(key: &OsStr) -> Result<String, VarError> {
|
||||
/// `'='` or the NUL character `'\0'`, or when the value contains 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,
|
||||
/// use the [`var`] function instead.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
|
Loading…
Reference in New Issue
Block a user