Struct Env Copy item path

impl Env

§Constants

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

?std 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 } }

?std 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 } }

?std 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)

impl Env

§Command line arguments

pub fn args() -> IterArgs ⓘ

Available on crate feature std only.

Returns the arguments that this program was started with.

See args.

pub fn args_os() -> IterArgsOs ⓘ

Available on crate feature std only.

See args_os.

impl Env

§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() -> IterVars ⓘ

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() -> IterVarsOs ⓘ

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 features std and unsafe_thread 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 features std and unsafe_thread only.

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

§Safety

See set_var.

impl Env

§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 home_dir() -> Option<PathBuf> ⓘ

Available on crate feature std only.

Returns the path of the current user’s home directory if known.

See home_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) -> IterSplitPaths<'_> ⓘ

Available on crate feature std only.

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

See split_paths.

Auto Trait Implementations§

impl UnwindSafe for Env

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

const BYTE_SIZE: usize = _

The size of this type in bytes.

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more

impl<T, R> Chain<R> for T
where T: ?Sized,

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.

impl<T> ExtAny for T
where T: Any + ?Sized,

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout only.

Returns some shared reference to the inner value if it is of type T. Read more

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout only.

Returns some exclusive reference to the inner value if it is of type T. Read more

impl<T> ExtMem for T
where T: ?Sized,

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &[u8]. Read more

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &mut [u8]. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<S> FromSample<S> for S

fn from_sample_(s: S) -> S

impl<T> Hook for T

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more