EnvConfig

Struct EnvConfig 

Source
pub struct EnvConfig<A, FM, L, V, EX, WD, B, N, ERR> {
    pub interactive: bool,
    pub args_env: A,
    pub file_desc_manager_env: FM,
    pub last_status_env: L,
    pub var_env: V,
    pub exec_env: EX,
    pub working_dir_env: WD,
    pub builtin_env: B,
    pub fn_name: PhantomData<N>,
    pub fn_error: PhantomData<ERR>,
}
Expand description

A struct for configuring a new Env instance.

It implements Default (via DefaultEnvConfig alias) so it is possible to selectively override certain environment modules while retaining the rest of the default implementations.

let env = Env::with_config(EnvConfig {
    args_env: ArgsEnv::with_name(Arc::new(String::from("my_shell"))),
    .. DefaultEnvConfig::new().expect("failed to create config")
});

assert_eq!(**env.name(), "my_shell");

Fields§

§interactive: bool

Specify if the environment is running in interactive mode.

§args_env: A

An implementation of ArgumentsEnvironment and possibly SetArgumentsEnvironment.

§file_desc_manager_env: FM

An implementation of FileDescManagerEnvironment.

§last_status_env: L

An implementation of LastStatusEnvironment.

§var_env: V

An implementation of VariableEnvironment, UnsetVariableEnvironment, and ExportedVariableEnvironment.

§exec_env: EX

An implementation of ExecutableEnvironment.

§working_dir_env: WD

An implementation of WorkingDirectoryEnvironment.

§builtin_env: B

An implementation of BuiltinEnvironment.

§fn_name: PhantomData<N>

A marker to indicate the type used for function names.

§fn_error: PhantomData<ERR>

A marker to indicate the type used for function errors.

Implementations§

Source§

impl<A, FM, L, V, EX, WD, B, N, ERR> EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

Source

pub fn change_args_env<T>( self, args_env: T, ) -> EnvConfig<T, FM, L, V, EX, WD, B, N, ERR>

Change the type of the args_env instance.

Source

pub fn change_file_desc_manager_env<T>( self, file_desc_manager_env: T, ) -> EnvConfig<A, T, L, V, EX, WD, B, N, ERR>

Change the type of the file_desc_manager_env instance.

Source

pub fn change_last_status_env<T>( self, last_status_env: T, ) -> EnvConfig<A, FM, T, V, EX, WD, B, N, ERR>

Change the type of the last_status_env instance.

Source

pub fn change_var_env<T>( self, var_env: T, ) -> EnvConfig<A, FM, L, T, EX, WD, B, N, ERR>

Change the type of the var_env instance.

Source

pub fn change_exec_env<T>( self, exec_env: T, ) -> EnvConfig<A, FM, L, V, T, WD, B, N, ERR>

Change the type of the exec_env instance.

Source

pub fn change_working_dir_env<T>( self, working_dir_env: T, ) -> EnvConfig<A, FM, L, V, EX, T, B, N, ERR>

Change the type of the working_dir_env instance.

Source

pub fn change_builtin_env<T>( self, builtin_env: T, ) -> EnvConfig<A, FM, L, V, EX, WD, T, N, ERR>

Change the type of the builtin_env instance.

Source

pub fn change_fn_name<T>(self) -> EnvConfig<A, FM, L, V, EX, WD, B, T, ERR>

Change the type of the fn_name instance.

Source

pub fn change_fn_error<T>(self) -> EnvConfig<A, FM, L, V, EX, WD, B, N, T>

Change the type of the fn_error instance.

Source§

impl<T> EnvConfig<ArgsEnv<T>, TokioFileDescManagerEnv, LastStatusEnv, VarEnv<T, T>, TokioExecEnv, VirtualWorkingDirEnv, BuiltinEnv<T>, T, RuntimeError>
where T: Eq + Hash + From<String>,

Source

pub fn new() -> Result<Self>

Creates a new DefaultEnvConfig using default environment components.

Trait Implementations§

Source§

impl<A: Clone, FM: Clone, L: Clone, V: Clone, EX: Clone, WD: Clone, B: Clone, N: Clone, ERR: Clone> Clone for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

Source§

fn clone(&self) -> EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

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<A: Debug, FM: Debug, L: Debug, V: Debug, EX: Debug, WD: Debug, B: Debug, N: Debug, ERR: Debug> Debug for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

Source§

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

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

impl<A: Default, FM: Default, L: Default, V: Default, EX: Default, WD: Default, B: Default, N: Default, ERR: Default> Default for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

Source§

fn default() -> EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

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

impl<A, FM, L, V, EX, WD, B, N, ERR> From<EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>> for Env<A, FM, L, V, EX, WD, B, N, ERR>

Source§

fn from(cfg: EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>) -> Self

Converts to this type from the input type.
Source§

impl<A: PartialEq, FM: PartialEq, L: PartialEq, V: PartialEq, EX: PartialEq, WD: PartialEq, B: PartialEq, N: PartialEq, ERR: PartialEq> PartialEq for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

Source§

fn eq(&self, other: &EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>) -> 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<A: Eq, FM: Eq, L: Eq, V: Eq, EX: Eq, WD: Eq, B: Eq, N: Eq, ERR: Eq> Eq for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

Source§

impl<A, FM, L, V, EX, WD, B, N, ERR> StructuralPartialEq for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

Auto Trait Implementations§

§

impl<A, FM, L, V, EX, WD, B, N, ERR> Freeze for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>
where A: Freeze, FM: Freeze, L: Freeze, V: Freeze, EX: Freeze, WD: Freeze, B: Freeze,

§

impl<A, FM, L, V, EX, WD, B, N, ERR> RefUnwindSafe for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

§

impl<A, FM, L, V, EX, WD, B, N, ERR> Send for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>
where A: Send, FM: Send, L: Send, V: Send, EX: Send, WD: Send, B: Send, N: Send, ERR: Send,

§

impl<A, FM, L, V, EX, WD, B, N, ERR> Sync for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>
where A: Sync, FM: Sync, L: Sync, V: Sync, EX: Sync, WD: Sync, B: Sync, N: Sync, ERR: Sync,

§

impl<A, FM, L, V, EX, WD, B, N, ERR> Unpin for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>
where A: Unpin, FM: Unpin, L: Unpin, V: Unpin, EX: Unpin, WD: Unpin, B: Unpin, N: Unpin, ERR: Unpin,

§

impl<A, FM, L, V, EX, WD, B, N, ERR> UnwindSafe for EnvConfig<A, FM, L, V, EX, WD, B, N, ERR>

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.