std::env - Rust
Description: API documentation for the Rust `env` mod in crate `std`.
Keywords: rust, rustlang, rust-lang, env

# Module std::env 1.0.0 [−] [src]

Inspection and manipulation of the process's environment.

This module contains functions to inspect various aspects such as environment variables, process arguments, the current directory, and various other important directories.

## Modules

consts | Constants associated with the current target

## Structs

Args | An iterator over the arguments of a process, yielding a `String` value for each argument.
ArgsOs | An iterator over the arguments of a process, yielding an `OsString` value for each argument.
JoinPathsError | Error type returned from `std::env::join_paths` when paths fail to be joined.
SplitPaths | An iterator over `PathBuf` instances for parsing an environment variable according to platform-specific conventions.
Vars | An iterator over a snapshot of the environment variables of this process.
VarsOs | An iterator over a snapshot of the environment variables of this process.

## Enums

VarError | Possible errors from the `env::var` function.

## Functions

args | Returns the arguments which this program was started with (normally passed via the command line).
args_os | Returns the arguments which this program was started with (normally passed via the command line).
current_dir | Returns the current working directory as a `PathBuf`.
current_exe | Returns the full filesystem path of the current running executable.
home_dir | Returns the path of the current user's home directory if known.
join_paths | Joins a collection of `Path`s appropriately for the `PATH` environment variable.
remove_var | Removes an environment variable from the environment of the currently running process.
set_current_dir | Changes the current working directory to the specified path, returning whether the change was completed successfully or not.
set_var | Sets the environment variable `k` to the value `v` for the currently running process.
split_paths | Parses input according to platform conventions for the `PATH` environment variable.
temp_dir | Returns the path of a temporary directory.
var | Fetches the environment variable `key` from the current process.
var_os | Fetches the environment variable `key` from the current process, returning `None` if the variable isn't set.
vars | Returns an iterator of (variable, value) pairs of strings, for all the environment variables of the current process.
vars_os | Returns an iterator of (variable, value) pairs of OS strings, for all the environment variables of the current process.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)