[go: up one dir, main page]

ParsingStyle

Enum ParsingStyle 

Source
pub enum ParsingStyle {
    AllOptions,
    StopAtFirstFree,
}
Expand description

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§

Source§

impl Clone for ParsingStyle

Source§

fn clone(&self) -> ParsingStyle

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParsingStyle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ParsingStyle

Source§

fn default() -> ParsingStyle

Returns the default parsing style, AllOptions.

Source§

impl PartialEq for ParsingStyle

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for ParsingStyle

Source§

impl Eq for ParsingStyle

Source§

impl StructuralPartialEq for ParsingStyle

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.