Struct Settings

Source
pub struct Settings { /* private fields */ }
Expand description

Settings used to control the parsers behaviour.

Implementations§

Source§

impl Settings

Source

pub fn new() -> Self

Create a new settings object.

Source

pub fn ignore_unknown_options(self) -> Self

Specify that unknown options should be silently ignored (by default, the first unknown option will generate an error).

Source

pub fn ignore_unknown_posn_args(self) -> Self

Specify that unknown positional arguments should be silently ignored (by default, they will generate an error).

Source

pub fn no_strict_options(self) -> Self

By default, arguments are parsed as they would be by getopt(3) whereby if an option is marked as requiring a value (Need::Argument) and the option is found on the command line, the next argument (whether it starts with a dash or not!) is “consumed” as the options argument.

However, when this setting is enabled, option values cannot start with a dash.

§Advice
  • If you want to your program to behave like the traditional getopt(3), leave this setting unset.
  • If you need your program to accept an argument starting with a dash (for example, you have an option which could accept a negative number), you should leave this setting unset.
  • If your program provides options and flags and you wish to minimse the chance of a flag (particularly a numeric flag such as -1 or -2) being interpreted as an options value, consider setting this option to disable support for option values starting with a dash.
§Example

If a program accepts a flag (-f) and an option that requires an value (-r <value>) and the following command-line is specified to the program…

$ prog -r -f

… the outcome of the parse will depend on this setting:

  • If no_strict_options=false (the default), the command line will be passed successfully and the r option (Arg) will be given the value “-f” and the f option (Arg) will be considered to not have been specified.

    Note:

    This is how the POSIX command line argument getopt(3) works.

  • If no_strict_options=true, the parse will fail with the error Error::MissingOptArg since in this mode, option values may not begin with a dash so the -f is treated as the next argument meaning the user forgot to specify a value for the previous argument (-r), which is an error.

    Note:

    This is an alternative behaviour adopted by some modern command line argument parsers.

Trait Implementations§

Source§

impl Clone for Settings

Source§

fn clone(&self) -> Settings

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 Settings

Source§

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

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

impl Default for Settings

Source§

fn default() -> Settings

Returns the “default value” for a type. Read more
Source§

impl Ord for Settings

Source§

fn cmp(&self, other: &Settings) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Settings

Source§

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

Source§

fn partial_cmp(&self, other: &Settings) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for Settings

Source§

impl Eq for Settings

Source§

impl StructuralPartialEq for Settings

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.