Struct gong::options::OptionSet

pub struct OptionSet<'r, 'a: 'r> {
    pub long: &'r [LongOption<'a>],
    pub short: &'r [ShortOption],
    pub mode: OptionsMode,
    pub allow_abbreviations: bool,
}

Option set

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

This is the non-“extendible” variant. Unlike its cousin OptionSetEx, this holds options lists as slice references rather than Vecs, and thus cannot be extended in size (hence no add_* methods). This is particularly useful in efficient creation of static/const option sets.

Fields

long: &'r [LongOption<'a>]

short: &'r [ShortOption]

mode: OptionsMode

allow_abbreviations: bool

Implementations

impl<'r, 'a: 'r> OptionSet<'r, 'a>

pub fn to_extendible(&self) -> OptionSetEx<'a>

Creates an “extendible” copy of self

This duplicates the options in self into an OptionSetEx.

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 is_valid(&self) -> bool

Checks validity of option set

Returns true if valid.

See also the validate method.

pub fn validate(&'r 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<'r, 'a: 'r> Clone for OptionSet<'r, 'a>

pub fn clone(&self) -> OptionSet<'r, 'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'r, 'a: 'r> Debug for OptionSet<'r, 'a>

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

Formats the value using the given formatter.

impl<'r, 'a: 'r> Default for OptionSet<'r, 'a>

pub fn default() -> OptionSet<'r, 'a>

Returns the "default value" for a type.

impl<'r, 'a: 'r> Eq for OptionSet<'r, 'a>

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

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

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

pub fn ne(&self, other: &OptionSet<'r, 'a>) -> bool

This method tests for !=.

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

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'r, 'a: 'r> StructuralEq for OptionSet<'r, 'a>

impl<'r, 'a: 'r> StructuralPartialEq for OptionSet<'r, 'a>