Struct ArgumentList

pub struct ArgumentList { /* private fields */ }

List of arguments of an option or command.

Implementations

impl ArgumentList

pub fn new() -> Self

Constructs a new ArgumentList.

pub fn len(&self) -> usize

Returns the number of arguments.

pub fn is_empty(&self) -> bool

Returns true if there is no arguments.

pub fn add(&mut self, arg: Argument) -> Result<(), Argument>

Adds an argument to the list, returns true if the argument was added otherwise if is a duplicate returns false.

Panics:

Panics if there is multiples options with default values.

pub fn get<S: AsRef<str>>(&self, arg_name: S) -> Option<&Argument>

Returns the Argument with the given name or None if no found.

pub fn get_raw_args(&self) -> RawArgs<'_>

Returns an iterator over the &str values of this ArgumentList.

pub fn get_raw_args_as_type<T>(&self) -> Result<Vec<T>>

where T: FromStr + 'static, <T as FromStr>::Err: Display,

Returns the values of all the arguments of this ArgumentList and convert them to type T.

Error

If one of the value cannot be parse to T.

pub fn contains<S: AsRef<str>>(&self, arg_name: S) -> bool

Returns true if contains an argument with the given name.

pub fn convert<T>(&self, arg_name: &str) -> Result<T>

where T: FromStr + 'static, <T as FromStr>::Err: Display,

Converts the value of the Argument with the given name.

Returns

• Ok(T) : If the String value of the argument can be parse to T.
• Err(error):
  • If the argument cannot be found.
  • If the value cannot be parse.
  • if there no value to parse.
  • if there is more than 1 value.

pub fn convert_at<T>(&self, index: usize) -> Result<T>

where T: FromStr + 'static, <T as FromStr>::Err: Display,

Converts the value of the Argument with the given index.

Panics

If the index is out of bounds.

Returns

• Ok(T) : If the String value of the argument can be parse to T.
• Err(error):
  • If the value cannot be parse.
  • if there no value to parse.
  • if there is more than 1 value.

pub fn convert_all<T>(&self, arg_name: &str) -> Result<Vec<T>>

where T: FromStr + 'static, <T as FromStr>::Err: Display,

Converts all values of the Argument with the given name.

Returns

• Ok(Vec<T>) : If all the values can be parsed to T.
• Err(error):
  • If the argument cannot be found.
  • If one of the values cannot be parse.
  • if there no values to parse.

pub fn clear(&mut self)

Removes all the Arguments.

pub fn iter(&self) -> Iter<'_>

Returns an Iterator over the arguments.

Trait Implementations

impl Clone for ArgumentList

fn clone(&self) -> ArgumentList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentList

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

Formats the value using the given formatter.

impl Default for ArgumentList

fn default() -> ArgumentList

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ArgumentList

fn deserialize<D>( deserializer: D, ) -> Result<Self, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index<&str> for ArgumentList

type Output = Argument

The returned type after indexing.

fn index(&self, arg_name: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<String> for ArgumentList

type Output = Argument

The returned type after indexing.

fn index(&self, arg_name: String) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for ArgumentList

type Output = Argument

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a ArgumentList

type Item = &'a Argument

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ArgumentList

type Item = Argument

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for ArgumentList

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ArgumentList

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ArgumentList

impl StructuralPartialEq for ArgumentList