Expand description
Inspection and manipulation of the process’s environment.
This module contains functions to inspect various aspects such asenvironment variables, process arguments, the current directory, and variousother important directories.
There are several functions and structs in this module that have acounterpart ending inos. Those ending inos will return anOsStringand those without will return aString.
Modules§
- consts
- Constants associated with the current target
Structs§
- Args
- An iterator over the arguments of a process, yielding a
Stringvalue foreach argument. - ArgsOs
- An iterator over the arguments of a process, yielding an
OsStringvaluefor each argument. - Join
Paths Error - The error type for operations on the
PATHvariable. Possibly returned fromenv::join_paths(). - Split
Paths - An iterator that splits an environment variable into paths according toplatform-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
- The error type for operations interacting with environment variables.Possibly returned from
env::var().
Functions§
- args
- Returns the arguments that this program was started with (normally passedvia the command line).
- args_os
- Returns the arguments that this program was started with (normally passedvia 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
Paths appropriately for thePATHenvironment 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.
- set_var⚠
- Sets the environment variable
keyto the valuevaluefor the currently runningprocess. - split_
paths - Parses input according to platform conventions for the
PATHenvironment variable. - temp_
dir - Returns the path of a temporary directory.
- var
- Fetches the environment variable
keyfrom the current process. - var_os
- Fetches the environment variable
keyfrom the current process, returningNoneif the variable isn’t set or if there is another error. - vars
- Returns an iterator of (variable, value) pairs of strings, for all theenvironment variables of the current process.
- vars_os
- Returns an iterator of (variable, value) pairs of OS strings, for all theenvironment variables of the current process.