Struct OptionList

pub struct OptionList { /* private fields */ }

Represents a collection of CommandOptions.

Implementations

impl OptionList

pub fn new() -> Self

Constructs a new empty Options.

pub fn add(&mut self, option: CommandOption) -> Result<(), CommandOption>

Adds the specified CommandOption.

Returns

false if there is an option with the same alias than the provided one.

pub fn add_or_replace(&mut self, option: CommandOption)

Adds the specified CommandOption or replace it it already exists,

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

Returns the CommandOption with the given name or alias or None if not found.

pub fn get_by_name<S: AsRef<str>>(&self, name: S) -> Option<&CommandOption>

Returns the CommandOption with the given name or None if not found.

pub fn get_by_alias<S: AsRef<str>>(&self, alias: S) -> Option<&CommandOption>

Returns the CommandOption with the given alias or None if not found.

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

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

Converts the argument value of the given option to the type T or results Err if:

• The option is not found.
• The option takes no arguments.
• The option takes more than 1 argument.
• The argument value parse fail.

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

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

Converts all the argument values of the given option to the type T or results Err if:

• The option is not found.
• The option takes no arguments.
• The option takes more than 1 argument.
• The argument values parse fail.

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

Returns the Argument of the option with the given name or alias or None if the option cannot be found or have more than 1 argument.

pub fn get_args<S: AsRef<str>>(&self, option: S) -> Option<&ArgumentList>

Returns the ArgumentList of the option with the given name or alias, or None if the option canno tbe found.

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

Returns true if there is an option with the given name or alias.

pub fn len(&self) -> usize

Returns the number of options in this collection.

pub fn is_empty(&self) -> bool

Returns true if there is no options.

pub fn clear(&mut self)

Removes all the Options.

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

Returns an ExactSizeIterator over the CommandOption of this collection.

Trait Implementations

impl Clone for OptionList

fn clone(&self) -> OptionList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptionList

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

Formats the value using the given formatter.

impl Default for OptionList

fn default() -> OptionList

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OptionList

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 OptionList

type Output = CommandOption

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a OptionList

type Item = &'a CommandOption

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 OptionList

type Item = CommandOption

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 OptionList

fn eq(&self, other: &OptionList) -> 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 OptionList

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 OptionList

impl StructuralPartialEq for OptionList