mirror of
https://github.com/rust-lang/rust.git
synced 2025-02-03 18:43:38 +00:00
Switch to intra-doc links for std/src/env.rs
This commit is contained in:
parent
509cad7f2f
commit
b6d2868caa
@ -7,9 +7,6 @@
|
||||
//! There are several functions and structs in this module that have a
|
||||
//! counterpart ending in `os`. Those ending in `os` will return an [`OsString`]
|
||||
//! and those without will return a [`String`].
|
||||
//!
|
||||
//! [`OsString`]: ../../std/ffi/struct.OsString.html
|
||||
//! [`String`]: ../string/struct.String.html
|
||||
|
||||
#![stable(feature = "env", since = "1.0.0")]
|
||||
|
||||
@ -31,8 +28,7 @@ use crate::sys::os as os_imp;
|
||||
/// * Current directory does not exist.
|
||||
/// * There are insufficient permissions to access the current directory.
|
||||
///
|
||||
/// [`PathBuf`]: ../../std/path/struct.PathBuf.html
|
||||
/// [`Err`]: ../../std/result/enum.Result.html#method.err
|
||||
/// [`Err`]: Result::Err
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -54,7 +50,7 @@ pub fn current_dir() -> io::Result<PathBuf> {
|
||||
///
|
||||
/// Returns an [`Err`] if the operation fails.
|
||||
///
|
||||
/// [`Err`]: ../../std/result/enum.Result.html#method.err
|
||||
/// [`Err`]: Result::Err
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -76,7 +72,7 @@ pub fn set_current_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
|
||||
/// This structure is created by the [`std::env::vars`] function. See its
|
||||
/// documentation for more.
|
||||
///
|
||||
/// [`std::env::vars`]: fn.vars.html
|
||||
/// [`std::env::vars`]: vars
|
||||
#[stable(feature = "env", since = "1.0.0")]
|
||||
pub struct Vars {
|
||||
inner: VarsOs,
|
||||
@ -87,7 +83,7 @@ pub struct Vars {
|
||||
/// This structure is created by the [`std::env::vars_os`] function. See
|
||||
/// its documentation for more.
|
||||
///
|
||||
/// [`std::env::vars_os`]: fn.vars_os.html
|
||||
/// [`std::env::vars_os`]: vars_os
|
||||
#[stable(feature = "env", since = "1.0.0")]
|
||||
pub struct VarsOs {
|
||||
inner: os_imp::Env,
|
||||
@ -106,7 +102,7 @@ pub struct VarsOs {
|
||||
/// environment is not valid unicode. If this is not desired, consider using the
|
||||
/// [`env::vars_os`] function.
|
||||
///
|
||||
/// [`env::vars_os`]: fn.vars_os.html
|
||||
/// [`env::vars_os`]: vars_os
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -222,7 +218,7 @@ fn _var(key: &OsStr) -> Result<String, VarError> {
|
||||
/// Fetches the environment variable `key` from the current process, returning
|
||||
/// [`None`] if the variable isn't set.
|
||||
///
|
||||
/// [`None`]: ../option/enum.Option.html#variant.None
|
||||
/// [`None`]: Option::None
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
@ -254,7 +250,7 @@ fn _var_os(key: &OsStr) -> Option<OsString> {
|
||||
/// The error type for operations interacting with environment variables.
|
||||
/// Possibly returned from the [`env::var`] function.
|
||||
///
|
||||
/// [`env::var`]: fn.var.html
|
||||
/// [`env::var`]: var
|
||||
#[derive(Debug, PartialEq, Eq, Clone)]
|
||||
#[stable(feature = "env", since = "1.0.0")]
|
||||
pub enum VarError {
|
||||
@ -382,8 +378,7 @@ fn _remove_var(k: &OsStr) {
|
||||
/// This structure is created by the [`std::env::split_paths`] function. See its
|
||||
/// documentation for more.
|
||||
///
|
||||
/// [`PathBuf`]: ../../std/path/struct.PathBuf.html
|
||||
/// [`std::env::split_paths`]: fn.split_paths.html
|
||||
/// [`std::env::split_paths`]: split_paths
|
||||
#[stable(feature = "env", since = "1.0.0")]
|
||||
pub struct SplitPaths<'a> {
|
||||
inner: os_imp::SplitPaths<'a>,
|
||||
@ -410,8 +405,6 @@ pub struct SplitPaths<'a> {
|
||||
/// None => println!("{} is not defined in the environment.", key)
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// [`PathBuf`]: ../../std/path/struct.PathBuf.html
|
||||
#[stable(feature = "env", since = "1.0.0")]
|
||||
pub fn split_paths<T: AsRef<OsStr> + ?Sized>(unparsed: &T) -> SplitPaths<'_> {
|
||||
SplitPaths { inner: os_imp::split_paths(unparsed.as_ref()) }
|
||||
@ -438,7 +431,7 @@ impl fmt::Debug for SplitPaths<'_> {
|
||||
/// The error type for operations on the `PATH` variable. Possibly returned from
|
||||
/// the [`env::join_paths`] function.
|
||||
///
|
||||
/// [`env::join_paths`]: fn.join_paths.html
|
||||
/// [`env::join_paths`]: join_paths
|
||||
#[derive(Debug)]
|
||||
#[stable(feature = "env", since = "1.0.0")]
|
||||
pub struct JoinPathsError {
|
||||
@ -450,13 +443,11 @@ pub struct JoinPathsError {
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// Returns an [`Err`][err] (containing an error message) if one of the input
|
||||
/// Returns an [`Err`] (containing an error message) if one of the input
|
||||
/// [`Path`]s contains an invalid character for constructing the `PATH`
|
||||
/// variable (a double quote on Windows or a colon on Unix).
|
||||
///
|
||||
/// [`Path`]: ../../std/path/struct.Path.html
|
||||
/// [`OsString`]: ../../std/ffi/struct.OsString.html
|
||||
/// [err]: ../../std/result/enum.Result.html#variant.Err
|
||||
/// [Err]: Result::Err
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -508,7 +499,7 @@ pub struct JoinPathsError {
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// [`env::split_paths`]: fn.split_paths.html
|
||||
/// [`env::split_paths`]: split_paths
|
||||
#[stable(feature = "env", since = "1.0.0")]
|
||||
pub fn join_paths<I, T>(paths: I) -> Result<OsString, JoinPathsError>
|
||||
where
|
||||
@ -688,8 +679,7 @@ pub fn current_exe() -> io::Result<PathBuf> {
|
||||
/// set to arbitrary text, and may not even exist. This means this property
|
||||
/// should not be relied upon for security purposes.
|
||||
///
|
||||
/// [`String`]: ../string/struct.String.html
|
||||
/// [`std::env::args`]: ./fn.args.html
|
||||
/// [`std::env::args`]: args
|
||||
#[stable(feature = "env", since = "1.0.0")]
|
||||
pub struct Args {
|
||||
inner: ArgsOs,
|
||||
@ -705,8 +695,7 @@ pub struct Args {
|
||||
/// set to arbitrary text, and may not even exist. This means this property
|
||||
/// should not be relied upon for security purposes.
|
||||
///
|
||||
/// [`OsString`]: ../ffi/struct.OsString.html
|
||||
/// [`std::env::args_os`]: ./fn.args_os.html
|
||||
/// [`std::env::args_os`]: args_os
|
||||
#[stable(feature = "env", since = "1.0.0")]
|
||||
pub struct ArgsOs {
|
||||
inner: sys::args::Args,
|
||||
@ -744,8 +733,6 @@ pub struct ArgsOs {
|
||||
/// println!("{}", argument);
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// [`args_os`]: ./fn.args_os.html
|
||||
#[stable(feature = "env", since = "1.0.0")]
|
||||
pub fn args() -> Args {
|
||||
Args { inner: args_os() }
|
||||
|
Loading…
Reference in New Issue
Block a user