pub struct Settings { /* private fields */ }
Expand description
Settings used to control the parsers behaviour.
Implementations§
Source§impl Settings
impl Settings
Sourcepub fn ignore_unknown_options(self) -> Self
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).
Sourcepub fn ignore_unknown_posn_args(self) -> Self
pub fn ignore_unknown_posn_args(self) -> Self
Specify that unknown positional arguments should be silently ignored (by default, they will generate an error).
Sourcepub fn no_strict_options(self) -> Self
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 ther
option (Arg) will be given the value “-f
” and thef
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 errorError::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.