Struct gong::options::OptionSetEx

pub struct OptionSetEx<'a> {
    pub long: Vec<LongOption<'a>>,
    pub short: Vec<ShortOption>,
    pub mode: OptionsMode,
    pub allow_abbreviations: bool,
}

Extendible option set

Used to supply the set of information about available options to match against

This is the “extendible” variant which uses Vecs to hold the option lists and thus is flexible in allowing addition of options, and may re-allocate as necessary.

Fields

long: Vec<LongOption<'a>>

short: Vec<ShortOption>

mode: OptionsMode

allow_abbreviations: bool

Implementations

impl<'a> OptionSetEx<'a>

pub fn new(count_long: usize, count_short: usize) -> Self

Create a new object. Takes estimations of the number of options to expect to be added (for efficient vector allocation).

pub fn as_fixed(&self) -> OptionSet<'_, 'a>

Create an OptionSet referencing self’s vectors as slices.

pub fn set_mode(&mut self, mode: OptionsMode) -> &mut Self

Set mode

pub fn set_allow_abbreviations(&mut self, allow: bool) -> &mut Self

Enable/disable abbreviated matching

pub fn is_empty(&self) -> bool

Checks if empty

pub fn add_long(&mut self, name: &'a str) -> &mut Self

Add a long option

Panics (debug only) on invalid name.

pub fn add_short(&mut self, ch: char) -> &mut Self

Add a short option

Panics (debug only) on invalid char choice.

pub fn add_long_data(&mut self, name: &'a str) -> &mut Self

Add a long option that expects data

Panics (debug only) on invalid name.

pub fn add_short_data(&mut self, ch: char) -> &mut Self

Add a short option that expects data

Panics (debug only) on invalid char choice.

pub fn add_existing_long(&mut self, long: LongOption<'a>) -> &mut Self

Add an existing (ready-made) long option

pub fn add_existing_short(&mut self, short: ShortOption) -> &mut Self

Add an existing (ready-made) short option

pub fn is_valid(&self) -> bool

Checks validity of option set

Returns true if valid.

See also the validate method.

pub fn validate(&self) -> Result<(), Vec<OptionFlaw<'a>>>

Checks validity of option set, returning details of any problems

pub fn process<T>(&self, args: &'a [T]) -> Analysis<'a>where
    T: AsRef<str>,

Analyses provided program arguments.

Returns a result set describing the result of the analysis. This may include &str references to strings provided in the args parameter and in self. Take note of this with respect to object lifetimes.

Expects self to be valid (see is_valid).

Trait Implementations

impl<'a> Clone for OptionSetEx<'a>

fn clone(&self) -> OptionSetEx<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for OptionSetEx<'a>

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

Formats the value using the given formatter.

impl<'a> Default for OptionSetEx<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'r, 'a: 'r> PartialEq<OptionSet<'r, 'a>> for OptionSetEx<'a>

fn eq(&self, rhs: &OptionSet<'r, 'a>) -> bool

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

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

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

impl<'r, 'a: 'r> PartialEq<OptionSetEx<'a>> for OptionSet<'r, 'a>

fn eq(&self, rhs: &OptionSetEx<'a>) -> bool

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

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

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

impl<'a> PartialEq<OptionSetEx<'a>> for OptionSetEx<'a>

fn eq(&self, other: &OptionSetEx<'a>) -> bool

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

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

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

impl<'a> Eq for OptionSetEx<'a>

impl<'a> StructuralEq for OptionSetEx<'a>

impl<'a> StructuralPartialEq for OptionSetEx<'a>