Enum gumdrop::ParsingStyle

pub enum ParsingStyle {
    AllOptions,
    StopAtFirstFree,
}

Controls behavior of free arguments in Parser

The parse_args_default and parse_args_default_or_exit functions will use the default parsing style, AllOptions.

Examples

use gumdrop::{Options, ParsingStyle};

#[derive(Options)]
struct MyOptions {
    // If the "-o" is parsed as an option, this will be `true`.
    option: bool,
    // All free (non-option) arguments will be collected into this Vec.
    #[options(free)]
    free: Vec<String>,
}

// Command line arguments.
let args = &["foo", "-o", "bar"];

// Using the `AllOptions` parsing style, the "-o" argument in the middle of args
// will be parsed as an option.
let opts = MyOptions::parse_args(args, ParsingStyle::AllOptions).unwrap();

assert_eq!(opts.option, true);
assert_eq!(opts.free, vec!["foo", "bar"]);

// Using the `StopAtFirstFree` option, the first non-option argument will terminate
// option parsing. That means "-o" is treated as a free argument.
let opts = MyOptions::parse_args(args, ParsingStyle::StopAtFirstFree).unwrap();

assert_eq!(opts.option, false);
assert_eq!(opts.free, vec!["foo", "-o", "bar"]);

Variants

AllOptions

Process all option arguments that appear

StopAtFirstFree

After the first “free” argument is encountered, all remaining arguments will be considered “free” arguments.

Trait Implementations

impl Clone for ParsingStyle

fn clone(&self) -> ParsingStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParsingStyle

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

Formats the value using the given formatter.

impl Default for ParsingStyle

fn default() -> ParsingStyle

Returns the default parsing style, AllOptions.

impl PartialEq<ParsingStyle> for ParsingStyle

fn eq(&self, other: &ParsingStyle) -> 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 !=.

impl Copy for ParsingStyle

impl Eq for ParsingStyle

impl StructuralEq for ParsingStyle

impl StructuralPartialEq for ParsingStyle