Env

Struct Env 

Source
pub struct Env { /* private fields */ }
Expand description

Safe wrapper around std::env::vars_os, which is safe to access on Windows: some of its environmental variables are case-insensitive.

Implementations§

Source§

impl Env

Source

pub fn new() -> Self

Create new default Env.

Source

pub fn new_from(env: HashMap<OsString, OsString>) -> Self

Create new Env using env as existing environmental variables.

Source

pub fn reload_from(&mut self, env: HashMap<OsString, OsString>)

Reload environmental variables from env.

Source

pub fn reload(&mut self)

Reload environmental variables from std::env::vars_os.

Source

pub fn get_os(&self, key: impl AsRef<OsStr>) -> Option<&OsStr>

Get environmental variable pointed by key.

§Arguments
  • key - key for environmental variable. Must implement AsRef<OsStr>.
§Returns

Option<&OsStr>. None variant indicates missing key, Some: existing key.

§Examples
use rustvil::os::env::Env;

let env = Env::new();
println!("$FOO = {:?}", env.get_os("FOO"));
Source

pub fn has(&self, key: impl AsRef<OsStr>) -> bool

Check, whether this Env has key key.

Source

pub fn get(&self, key: impl AsRef<OsStr>) -> Result<&str, EnvStrError>

Get environmental variable pointed by key and convert it to UTF-8.

§Arguments
  • key - key for environmental variable. Must implement AsRef<Str>.
§Returns

Result<&str, EnvStrError>. Ok variant indicates existing UTF-8 variable, Err indicates some kind of error. See EnvStrError for details.

§Examples
use rustvil::os::env::Env;

let env = Env::new();
let _path = env.get("PATH")?;

Trait Implementations§

Source§

impl Clone for Env

Source§

fn clone(&self) -> Env

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Env

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Env

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<const N: usize> From<[(OsString, OsString); N]> for Env

Source§

fn from(value: [(OsString, OsString); N]) -> Self

Converts to this type from the input type.
Source§

impl FromIterator<(OsString, OsString)> for Env

Source§

fn from_iter<T: IntoIterator<Item = (OsString, OsString)>>(iter: T) -> Self

Creates a value from an iterator. Read more
Source§

impl PartialEq for Env

Source§

fn eq(&self, other: &Env) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Env

Source§

impl StructuralPartialEq for Env

Auto Trait Implementations§

§

impl Freeze for Env

§

impl RefUnwindSafe for Env

§

impl Send for Env

§

impl Sync for Env

§

impl Unpin for Env

§

impl UnwindSafe for Env

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.