Struct Env

pub struct Env;

A namespaced wrapper for std::env functions and constants.

Implementations

impl Env

Functions related to command line arguments

pub fn args() -> Args

Available on crate feature std only.

Returns the arguments that this program was started with.

See args.

pub fn args_os() -> ArgsOs

Available on crate feature std only.

See args_os.

impl Env

Functions related to environment variables

pub fn var<K: AsRef<OsStr>>(key: K) -> Result<String, VarError>

Available on crate feature std only.

Fetches the environment variable key from the current process.

See var.

pub fn vars() -> Vars

Available on crate feature std only.

Returns an iterator of (variable, value) pairs of strings, for all the environment variables of the current process.

See vars.

pub fn var_os<K: AsRef<OsStr>>(key: K) -> Option<OsString>

Available on crate feature std only.

Fetches the environment variable key from the current process.

See var_os.

pub fn vars_os() -> VarsOs

Available on crate feature std only.

Returns an iterator of (variable, value) pairs of OS strings, for all the environment variables of the current process.

See vars_os.

pub unsafe fn remove_var<K: AsRef<OsStr>>(key: K)

Available on crate feature std only.

Removes the environment variable key from the environment of the currently running process.

Safety

See remove_var.

pub unsafe fn set_var<K: AsRef<OsStr>, V: AsRef<OsStr>>(key: K, value: V)

Available on crate feature std only.

Sets the environment variable key to the value value for the currently running process.

Safety

See set_var.

impl Env

Functions related to paths.

pub fn current_exe() -> IoResult<PathBuf>

Available on crate feature std only.

Returns the full filesystem path of the current running executable.

See current_exe.

pub fn current_dir() -> IoResult<PathBuf>

Available on crate feature std only.

Returns the current working directory.

See current_dir.

pub fn set_current_dir<P: AsRef<Path>>(path: P) -> IoResult<()>

Available on crate feature std only.

Changes the current working directory to the specified path.

See set_current_dir.

pub fn temp_dir() -> PathBuf

Available on crate feature std only.

Returns the path of a temporary directory.

See temp_dir.

pub fn join_paths<I, T>(paths: I) -> Result<OsString, JoinPathsError>

where I: IntoIterator<Item = T>, T: AsRef<OsStr>,

Available on crate feature std only.

Joins a collection of Paths appropriately for the PATH environment variable.

See join_paths.

pub fn split_paths<T: AsRef<OsStr> + ?Sized>(unparsed: &T) -> SplitPaths<'_>

Available on crate feature std only.

Parses input according to platform conventions for the PATH environment variable.

See split_paths.

impl Env

Constants

pub const ARCH: &'static str = { { std::env::consts::ARCH } }

A string describing the architecture of the CPU that is currently in use.

Expected values are: aarch64, arm, arm64ec, avr, bpf, csky, hexagon, loongarch64, m68k, mips, mips32r6, mips64, mips64r6, msp430, nvptx64, powerpc, powerpc64, riscv32, riscv64, s390x, sparc, sparc64, wasm32, wasm64, x86, x86_64, and xtensa.

pub const FAMILY: &'static str = { { std::env::consts::FAMILY } }

The family of the operating system.

The expected values are: unix, wasm, and windows

pub const VENDOR: &'static str = { { "unknown" } }

A string describing the vendor of the CPU that is currently in use.

Expected values are: apple, espressif, fortanix, ibm, kmc, nintendo, nvidia, pc, risc0, sony, sun, unikraft, unknown, uwp, win7, and wrs.

pub const OS: &'static str = { { std::env::consts::OS } }

A string describing the specific operating system in use.

The expected values are: aix, android, cuda, dragonfly, emscripten, espidf, freebsd, fuchsia, haiku, hermit, horizon, hurd, illumos, ios, l4re, linux, macos, netbsd, none, nto, nuttx, openbsd, psp, redox, rtems, solaris, solid_asp3, teeos, trusty, tvos, uefi, unknown, visionos, vita, vxworks, wasi, watchos, windows, xous, and zkvm.

pub const DLL_EXTENSION: &'static str = std::env::consts::DLL_EXTENSION

Available on crate feature std only.

Specifies the file extension used for shared libraries on this platform that goes after the dot.

Some possible values:

• so
• dylib
• dll

pub const DLL_PREFIX: &'static str = std::env::consts::DLL_PREFIX

Available on crate feature std only.

Specifies the filename prefix used for shared libraries on this platform.

Some possible values:

• lib
• “” (an empty string)

pub const DLL_SUFFIX: &'static str = std::env::consts::DLL_SUFFIX

Available on crate feature std only.

Specifies the filename suffix used for shared libraries on this platform.

Some possible values:

• .so
• .dylib
• .dll

pub const EXE_EXTENSION: &'static str = std::env::consts::EXE_EXTENSION

Available on crate feature std only.

Specifies the file extension, if any, used for executable binaries on this platform.

Some possible values:

• exe
• “” (an empty string)

pub const EXE_SUFFIX: &'static str = std::env::consts::EXE_SUFFIX

Available on crate feature std only.

Specifies the filename suffix used for executable binaries on this platform.

Some possible values:

• .exe
• .nexe
• .pexe
• “” (an empty string)