Struct nu_protocol::EvaluatedArgs

pub struct EvaluatedArgs {
    pub positional: Option<Vec<Value>>,
    pub named: Option<IndexMap<String, Value>>,
}

The set of positional and named arguments, after their values have been evaluated.

• Positional arguments are those who are given as values, without any associated flag. For example, in foo arg1 arg2, both arg1 and arg2 are positional arguments.
• Named arguments are those associated with a flag. For example, foo --given bar the named argument would be name given and the value bar.

Fields

positional: Option<Vec<Value>>

named: Option<IndexMap<String, Value>>

Implementations

impl EvaluatedArgs

pub fn new(
    positional: Option<Vec<Value>>,
    named: Option<IndexMap<String, Value>>
) -> Self

Constructs a new EvaluatedArgs.

impl EvaluatedArgs

pub fn slice_from(&self, from: usize) -> Vec<Value>

Retrieve a subset of positional arguments starting at a given position

pub fn nth(&self, pos: usize) -> Option<&Value>

Get the nth positional argument, if possible

pub fn expect_nth(&self, pos: usize) -> Result<&Value, ShellError>

Get the nth positional argument, error if not possible

pub fn len(&self) -> usize

Get the number of positional arguments available

pub fn is_empty(&self) -> bool

Return if there are no positional arguments

pub fn has(&self, name: &str) -> bool

Return true if the set of named arguments contains the name provided

pub fn get(&self, name: &str) -> Option<&Value>

Gets the corresponding Value for the named argument given, if possible

pub fn expect_get(&self, name: &str) -> Result<&Value, ShellError>

Gets the corresponding Value for the named argument given, error if not possible

pub fn positional_iter(&self) -> PositionalIter<'_>

Iterates over the positional arguments

Trait Implementations

impl Clone for EvaluatedArgs

fn clone(&self) -> EvaluatedArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EvaluatedArgs

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

Formats the value using the given formatter.

impl Default for EvaluatedArgs

fn default() -> EvaluatedArgs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EvaluatedArgs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for EvaluatedArgs

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.