Struct conch_runtime::env::atomic::ArgsEnv

pub struct ArgsEnv<T> { /* fields omitted */ }

An environment module for setting and getting shell and function arguments.

Uses Arc internally. If Send and Sync is not required of the implementation, see env::ArgsEnv as a cheaper alternative.

Methods

impl<T> AtomicArgsEnv<T>

fn new() -> Self where
    T: From<String>, 

Constructs a new environment and initializes it with the name of the current process as the shell name, and no arguments.

fn with_name(name: T) -> Self

Constructs a new environment and initializes it with the provided name and no arguments.

fn with_name_and_args<I: IntoIterator<Item = T>>(name: T, args: I) -> Self

Constructs a new environment and initializes it with the provided name and positional arguments.

Trait Implementations

impl<T: Debug> Debug for AtomicArgsEnv<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for AtomicArgsEnv<T>

fn eq(&self, __arg_0: &AtomicArgsEnv<T>) -> bool

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

fn ne(&self, __arg_0: &AtomicArgsEnv<T>) -> bool

This method tests for !=.

impl<T: Eq> Eq for AtomicArgsEnv<T>

impl<T: From<String>> Default for AtomicArgsEnv<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T> Clone for AtomicArgsEnv<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> SubEnvironment for AtomicArgsEnv<T>

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.

impl<T: Clone> ArgumentsEnvironment for AtomicArgsEnv<T>

type Arg = T

The type of arguments this environment holds.

fn name(&self) -> &Self::Arg

Get the name of the shell.

fn arg(&self, idx: usize) -> Option<&Self::Arg>

Get an argument at any index. Arguments are 1-indexed since the shell variable $0 refers to the shell's name. Thus the first real argument starts at index 1.

fn args_len(&self) -> usize

Get the number of current arguments, NOT including the shell name.

fn args(&self) -> Cow<[Self::Arg]>

Get all current arguments as a possibly owned slice.

impl<T: Clone> SetArgumentsEnvironment for AtomicArgsEnv<T>

type Args = Arc<Vec<T>>

A collection of arguments to set.

fn set_args(&mut self, new_args: Self::Args) -> Self::Args

Changes the environment's arguments to new_args and returns the old arguments.

impl<T: Clone> ShiftArgumentsEnvironment for AtomicArgsEnv<T>

fn shift_args(&mut self, amt: usize)

Shift parameters such that the positional parameter n will hold the value of the positional parameter n + amt.