Struct conch_runtime::env::VarEnv

pub struct VarEnv<N: Eq + Hash, V> { /* fields omitted */ }

An environment module for setting and getting shell variables.

Uses Rc internally. For a possible Send and Sync implementation, see env::atomic::VarEnv.

Methods

impl<N: Eq + Hash, V> VarEnv<N, V>

fn new() -> Self

Constructs a new environment with no environment variables.

fn with_process_env_vars() -> Self where
    N: From<String>,
    V: From<String>, 

Constructs a new environment and initializes it with the environment variables of the current process.

fn with_env_vars<I: IntoIterator<Item = (N, V)>>(iter: I) -> Self

Constructs a new environment with a provided collection of (key, value) environment variable pairs. These variables (if any) will be inherited by all commands.

Trait Implementations

impl<N: PartialEq + Eq + Hash, V: PartialEq> PartialEq for VarEnv<N, V>

fn eq(&self, __arg_0: &VarEnv<N, V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &VarEnv<N, V>) -> bool

This method tests for !=.

impl<N: Eq + Eq + Hash, V: Eq> Eq for VarEnv<N, V>

impl<N: Eq + Hash + Clone, V: Clone + Eq> VariableEnvironment for VarEnv<N, V>

type VarName = N

The type of the name this environment associates for a variable.

type Var = V

The type of variables this environment holds.

fn var<Q: ?Sized>(&self, name: &Q) -> Option<&Self::Var> where
    Self::VarName: Borrow<Q>,
    Q: Hash + Eq, 

Get the value of some variable. The values of both shell-only and environment variables will be looked up and returned.

fn set_var(&mut self, name: Self::VarName, val: Self::Var)

Set the value of some variable, maintaining its status as an environment variable if previously set as such.

fn env_vars(&self) -> Cow<[(&Self::VarName, &Self::Var)]>

Unset the value of some variable (including environment variables). Get all current pairs of environment variables and their values.

impl<N: Eq + Hash + Clone, V: Clone + Eq> ExportedVariableEnvironment for VarEnv<N, V>

fn exported_var(&self, name: &Self::VarName) -> Option<(&Self::Var, bool)>

Get the value of some variable and whether it is exported.

fn set_exported_var(
    &mut self,
    name: Self::VarName,
    val: Self::Var,
    exported: bool
)

Set the value of some variable, and set it's exported status as specified.

impl<N: Eq + Hash + Clone, V: Eq + Clone> UnsetVariableEnvironment for VarEnv<N, V>

fn unset_var<Q: ?Sized>(&mut self, name: &Q) where
    Self::VarName: Borrow<Q>,
    Q: Hash + Eq, 

Unset the value of some variable (including environment variables).

impl<N: Eq + Ord + Hash + Debug, V: Debug> Debug for VarEnv<N, V>

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<N: Eq + Hash, V> Default for VarEnv<N, V>

fn default() -> Self

Returns the "default value" for a type.

impl<N: Eq + Hash, V> Clone for VarEnv<N, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Eq + Hash, V> SubEnvironment for VarEnv<N, V>

fn sub_env(&self) -> Self

Create a new sub-environment, which starts out idential to its parent, but any changes on the new environment will not be reflected on the parent.