| // Copyright (C) 2017-2019 Baidu, Inc. All Rights Reserved. |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions |
| // are met: |
| // |
| // * Redistributions of source code must retain the above copyright |
| // notice, this list of conditions and the following disclaimer. |
| // * Redistributions in binary form must reproduce the above copyright |
| // notice, this list of conditions and the following disclaimer in |
| // the documentation and/or other materials provided with the |
| // distribution. |
| // * Neither the name of Baidu, Inc., nor the names of its |
| // contributors may be used to endorse or promote products derived |
| // from this software without specific prior written permission. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| //! Inspection and manipulation of the process's environment. |
| |
| use crate::error::Error; |
| use crate::ffi::{OsStr, OsString}; |
| use crate::path::PathBuf; |
| use crate::sys::os as os_imp; |
| use core::fmt; |
| |
| /// An iterator over a snapshot of the environment variables of this process. |
| /// |
| pub struct Vars { inner: VarsOs } |
| |
| /// An iterator over a snapshot of the environment variables of this process. |
| /// |
| pub struct VarsOs { inner: os_imp::Env } |
| |
| /// Returns an iterator of (variable, value) pairs of strings, for all the |
| /// environment variables of the current process. |
| /// |
| /// The returned iterator contains a snapshot of the process's environment |
| /// variables at the time of this invocation. Modifications to environment |
| /// variables afterwards will not be reflected in the returned iterator. |
| /// |
| /// # Panics |
| /// |
| /// While iterating, the returned iterator will panic if any key or value in the |
| /// environment is not valid unicode. If this is not desired, consider using the |
| /// [`env::vars_os`] function. |
| /// |
| pub fn vars() -> Vars { |
| Vars { inner: vars_os() } |
| } |
| |
| /// Returns an iterator of (variable, value) pairs of OS strings, for all the |
| /// environment variables of the current process. |
| /// |
| /// The returned iterator contains a snapshot of the process's environment |
| /// variables at the time of this invocation. Modifications to environment |
| /// variables afterwards will not be reflected in the returned iterator. |
| /// |
| pub fn vars_os() -> VarsOs { |
| VarsOs { inner: os_imp::env() } |
| } |
| |
| impl Iterator for Vars { |
| type Item = (String, String); |
| fn next(&mut self) -> Option<(String, String)> { |
| self.inner.next().map(|(a, b)| { |
| (a.into_string().unwrap(), b.into_string().unwrap()) |
| }) |
| } |
| fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() } |
| } |
| |
| impl fmt::Debug for Vars { |
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| f.pad("Vars { .. }") |
| } |
| } |
| |
| impl Iterator for VarsOs { |
| type Item = (OsString, OsString); |
| fn next(&mut self) -> Option<(OsString, OsString)> { self.inner.next() } |
| fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() } |
| } |
| |
| impl fmt::Debug for VarsOs { |
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| f.pad("VarsOs { .. }") |
| } |
| } |
| |
| /// Fetches the environment variable `key` from the current process. |
| /// |
| /// # Errors |
| /// |
| /// * Environment variable is not present |
| /// * Environment variable is not valid unicode |
| /// |
| pub fn var<K: AsRef<OsStr>>(key: K) -> Result<String, VarError> { |
| _var(key.as_ref()) |
| } |
| |
| fn _var(key: &OsStr) -> Result<String, VarError> { |
| match var_os(key) { |
| Some(s) => s.into_string().map_err(VarError::NotUnicode), |
| None => Err(VarError::NotPresent), |
| } |
| } |
| |
| /// Fetches the environment variable `key` from the current process, returning |
| /// [`None`] if the variable isn't set. |
| /// |
| pub fn var_os<K: AsRef<OsStr>>(key: K) -> Option<OsString> { |
| _var_os(key.as_ref()) |
| } |
| |
| fn _var_os(key: &OsStr) -> Option<OsString> { |
| os_imp::getenv(key).unwrap_or_else(|e| { |
| panic!("failed to get environment variable `{:?}`: {}", key, e) |
| }) |
| } |
| |
| /// The error type for operations interacting with environment variables. |
| /// Possibly returned from the [`env::var`] function. |
| /// |
| #[derive(Debug, PartialEq, Eq, Clone)] |
| pub enum VarError { |
| /// The specified environment variable was not present in the current |
| /// process's environment. |
| NotPresent, |
| |
| /// The specified environment variable was found, but it did not contain |
| /// valid unicode data. The found data is returned as a payload of this |
| /// variant. |
| NotUnicode(OsString), |
| } |
| |
| impl fmt::Display for VarError { |
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| match *self { |
| VarError::NotPresent => write!(f, "environment variable not found"), |
| VarError::NotUnicode(ref s) => { |
| write!(f, "environment variable was not valid unicode: {:?}", s) |
| } |
| } |
| } |
| } |
| |
| impl Error for VarError { |
| fn description(&self) -> &str { |
| match *self { |
| VarError::NotPresent => "environment variable not found", |
| VarError::NotUnicode(..) => "environment variable was not valid unicode", |
| } |
| } |
| } |
| |
| /// Sets the environment variable `k` to the value `v` for the currently running |
| /// process. |
| /// |
| /// Note that while concurrent access to environment variables is safe in Rust, |
| /// some platforms only expose inherently unsafe non-threadsafe APIs for |
| /// inspecting the environment. As a result extra care needs to be taken when |
| /// auditing calls to unsafe external FFI functions to ensure that any external |
| /// environment accesses are properly synchronized with accesses in Rust. |
| /// |
| /// # Panics |
| /// |
| /// This function may panic if `key` is empty, contains an ASCII equals sign |
| /// `'='` or the NUL character `'\0'`, or when the value contains the NUL |
| /// character. |
| /// |
| pub fn set_var<K: AsRef<OsStr>, V: AsRef<OsStr>>(k: K, v: V) { |
| _set_var(k.as_ref(), v.as_ref()) |
| } |
| |
| fn _set_var(k: &OsStr, v: &OsStr) { |
| os_imp::setenv(k, v).unwrap_or_else(|e| { |
| panic!("failed to set environment variable `{:?}` to `{:?}`: {}", |
| k, v, e) |
| }) |
| } |
| |
| /// Removes an environment variable from the environment of the currently running process. |
| /// |
| /// Note that while concurrent access to environment variables is safe in Rust, |
| /// some platforms only expose inherently unsafe non-threadsafe APIs for |
| /// inspecting the environment. As a result extra care needs to be taken when |
| /// auditing calls to unsafe external FFI functions to ensure that any external |
| /// environment accesses are properly synchronized with accesses in Rust. |
| /// |
| /// # Panics |
| /// |
| /// This function may panic if `key` is empty, contains an ASCII equals sign |
| /// `'='` or the NUL character `'\0'`, or when the value contains the NUL |
| /// character. |
| /// |
| pub fn remove_var<K: AsRef<OsStr>>(k: K) { |
| _remove_var(k.as_ref()) |
| } |
| |
| fn _remove_var(k: &OsStr) { |
| os_imp::unsetenv(k).unwrap_or_else(|e| { |
| panic!("failed to remove environment variable `{:?}`: {}", k, e) |
| }) |
| } |
| |
| /// An iterator that splits an environment variable into paths according to |
| /// platform-specific conventions. |
| /// |
| pub struct SplitPaths<'a> { inner: os_imp::SplitPaths<'a> } |
| |
| /// Parses input according to platform conventions for the `PATH` |
| /// environment variable. |
| /// |
| /// Returns an iterator over the paths contained in `unparsed`. |
| /// |
| pub fn split_paths<T: AsRef<OsStr> + ?Sized>(unparsed: &T) -> SplitPaths<'_> { |
| SplitPaths { inner: os_imp::split_paths(unparsed.as_ref()) } |
| } |
| |
| impl<'a> Iterator for SplitPaths<'a> { |
| type Item = PathBuf; |
| fn next(&mut self) -> Option<PathBuf> { self.inner.next() } |
| fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() } |
| } |
| |
| impl fmt::Debug for SplitPaths<'_> { |
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| f.pad("SplitPaths { .. }") |
| } |
| } |
| |
| /// The error type for operations on the `PATH` variable. Possibly returned from |
| /// the [`env::join_paths`] function. |
| /// |
| #[derive(Debug)] |
| pub struct JoinPathsError { |
| inner: os_imp::JoinPathsError |
| } |
| |
| /// Joins a collection of [`Path`]s appropriately for the `PATH` |
| /// environment variable. |
| /// |
| /// # Errors |
| /// |
| /// Returns an [`Err`][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 |
| /// |
| pub fn join_paths<I, T>(paths: I) -> Result<OsString, JoinPathsError> |
| where I: IntoIterator<Item=T>, T: AsRef<OsStr> |
| { |
| os_imp::join_paths(paths.into_iter()).map_err(|e| { |
| JoinPathsError { inner: e } |
| }) |
| } |
| |
| impl fmt::Display for JoinPathsError { |
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| self.inner.fmt(f) |
| } |
| } |
| |
| impl Error for JoinPathsError { |
| fn description(&self) -> &str { self.inner.description() } |
| } |
| |
| pub fn temp_dir() -> PathBuf { |
| os_imp::temp_dir() |
| } |
| |
| /// Constants associated with the current target |
| pub mod consts { |
| use crate::sys::env::os; |
| |
| /// A string describing the architecture of the CPU that is currently |
| /// in use. |
| /// |
| /// Some possible values: |
| /// |
| /// - x86 |
| /// - x86_64 |
| /// - arm |
| /// - aarch64 |
| /// - mips |
| /// - mips64 |
| /// - powerpc |
| /// - powerpc64 |
| /// - s390x |
| /// - sparc64 |
| pub const ARCH: &str = super::arch::ARCH; |
| |
| /// The family of the operating system. Example value is `unix`. |
| /// |
| /// Some possible values: |
| /// |
| /// - unix |
| /// - windows |
| pub const FAMILY: &str = os::FAMILY; |
| |
| /// A string describing the specific operating system in use. |
| /// Example value is `linux`. |
| /// |
| /// Some possible values: |
| /// |
| /// - linux |
| /// - macos |
| /// - ios |
| /// - freebsd |
| /// - dragonfly |
| /// - bitrig |
| /// - netbsd |
| /// - openbsd |
| /// - solaris |
| /// - android |
| /// - windows |
| pub const OS: &str = os::OS; |
| |
| /// Specifies the filename prefix used for shared libraries on this |
| /// platform. Example value is `lib`. |
| /// |
| /// Some possible values: |
| /// |
| /// - lib |
| /// - `""` (an empty string) |
| pub const DLL_PREFIX: &str = os::DLL_PREFIX; |
| |
| /// Specifies the filename suffix used for shared libraries on this |
| /// platform. Example value is `.so`. |
| /// |
| /// Some possible values: |
| /// |
| /// - .so |
| /// - .dylib |
| /// - .dll |
| pub const DLL_SUFFIX: &str = os::DLL_SUFFIX; |
| |
| /// Specifies the file extension used for shared libraries on this |
| /// platform that goes after the dot. Example value is `so`. |
| /// |
| /// Some possible values: |
| /// |
| /// - so |
| /// - dylib |
| /// - dll |
| pub const DLL_EXTENSION: &str = os::DLL_EXTENSION; |
| |
| /// Specifies the filename suffix used for executable binaries on this |
| /// platform. Example value is `.exe`. |
| /// |
| /// Some possible values: |
| /// |
| /// - .exe |
| /// - .nexe |
| /// - .pexe |
| /// - `""` (an empty string) |
| pub const EXE_SUFFIX: &str = os::EXE_SUFFIX; |
| |
| /// Specifies the file extension, if any, used for executable binaries |
| /// on this platform. Example value is `exe`. |
| /// |
| /// Some possible values: |
| /// |
| /// - exe |
| /// - `""` (an empty string) |
| pub const EXE_EXTENSION: &str = os::EXE_EXTENSION; |
| } |
| |
| #[cfg(target_arch = "x86")] |
| mod arch { |
| pub const ARCH: &str = "x86"; |
| } |
| |
| #[cfg(target_arch = "x86_64")] |
| mod arch { |
| pub const ARCH: &str = "x86_64"; |
| } |