pub struct Options { /* private fields */ }
Expand description
A description of the options that a program can handle.
Implementations§
source§impl Options
impl Options
sourcepub fn parsing_style(&mut self, style: ParsingStyle) -> &mut Options
pub fn parsing_style(&mut self, style: ParsingStyle) -> &mut Options
Set the parsing style.
sourcepub fn long_only(&mut self, long_only: bool) -> &mut Options
pub fn long_only(&mut self, long_only: bool) -> &mut Options
Set or clear “long options only” mode.
In “long options only” mode, short options cannot be clustered together, and long options can be given with either a single “-” or the customary “–”. This mode also changes the meaning of “-a=b”; in the ordinary mode this will parse a short option “-a” with argument “=b”; whereas in long-options-only mode the argument will be simply “b”.
sourcepub fn opt(
&mut self,
short_name: &str,
long_name: &str,
desc: &str,
hint: &str,
hasarg: HasArg,
occur: Occur
) -> &mut Options
pub fn opt( &mut self, short_name: &str, long_name: &str, desc: &str, hint: &str, hasarg: HasArg, occur: Occur ) -> &mut Options
Create a generic option group, stating all parameters explicitly.
sourcepub fn optflag(
&mut self,
short_name: &str,
long_name: &str,
desc: &str
) -> &mut Options
pub fn optflag( &mut self, short_name: &str, long_name: &str, desc: &str ) -> &mut Options
Create a long option that is optional and does not take an argument.
short_name
- e.g."h"
for a-h
option, or""
for nonelong_name
- e.g."help"
for a--help
option, or""
for nonedesc
- Description for usage help
sourcepub fn optflagmulti(
&mut self,
short_name: &str,
long_name: &str,
desc: &str
) -> &mut Options
pub fn optflagmulti( &mut self, short_name: &str, long_name: &str, desc: &str ) -> &mut Options
Create a long option that can occur more than once and does not take an argument.
short_name
- e.g."h"
for a-h
option, or""
for nonelong_name
- e.g."help"
for a--help
option, or""
for nonedesc
- Description for usage help
sourcepub fn optflagopt(
&mut self,
short_name: &str,
long_name: &str,
desc: &str,
hint: &str
) -> &mut Options
pub fn optflagopt( &mut self, short_name: &str, long_name: &str, desc: &str, hint: &str ) -> &mut Options
Create a long option that is optional and takes an optional argument.
short_name
- e.g."h"
for a-h
option, or""
for nonelong_name
- e.g."help"
for a--help
option, or""
for nonedesc
- Description for usage helphint
- Hint that is used in place of the argument in the usage help, e.g."FILE"
for a-o FILE
option
sourcepub fn optmulti(
&mut self,
short_name: &str,
long_name: &str,
desc: &str,
hint: &str
) -> &mut Options
pub fn optmulti( &mut self, short_name: &str, long_name: &str, desc: &str, hint: &str ) -> &mut Options
Create a long option that is optional, takes an argument, and may occur multiple times.
short_name
- e.g."h"
for a-h
option, or""
for nonelong_name
- e.g."help"
for a--help
option, or""
for nonedesc
- Description for usage helphint
- Hint that is used in place of the argument in the usage help, e.g."FILE"
for a-o FILE
option
sourcepub fn optopt(
&mut self,
short_name: &str,
long_name: &str,
desc: &str,
hint: &str
) -> &mut Options
pub fn optopt( &mut self, short_name: &str, long_name: &str, desc: &str, hint: &str ) -> &mut Options
Create a long option that is optional and takes an argument.
short_name
- e.g."h"
for a-h
option, or""
for nonelong_name
- e.g."help"
for a--help
option, or""
for nonedesc
- Description for usage helphint
- Hint that is used in place of the argument in the usage help, e.g."FILE"
for a-o FILE
option
sourcepub fn reqopt(
&mut self,
short_name: &str,
long_name: &str,
desc: &str,
hint: &str
) -> &mut Options
pub fn reqopt( &mut self, short_name: &str, long_name: &str, desc: &str, hint: &str ) -> &mut Options
Create a long option that is required and takes an argument.
short_name
- e.g."h"
for a-h
option, or""
for nonelong_name
- e.g."help"
for a--help
option, or""
for nonedesc
- Description for usage helphint
- Hint that is used in place of the argument in the usage help, e.g."FILE"
for a-o FILE
option
sourcepub fn parse<C>(&self, args: C) -> Result<Matches, Fail>where
C: IntoIterator,
<C as IntoIterator>::Item: AsRef<OsStr>,
pub fn parse<C>(&self, args: C) -> Result<Matches, Fail>where C: IntoIterator, <C as IntoIterator>::Item: AsRef<OsStr>,
Parse command line arguments according to the provided options.
On success returns Ok(Matches)
. Use methods such as opt_present
opt_str
, etc. to interrogate results.
Panics
Returns Err(Fail)
on failure: use the Debug
implementation of Fail
to display information about it.
sourcepub fn short_usage(&self, program_name: &str) -> String
pub fn short_usage(&self, program_name: &str) -> String
Derive a short one-line usage summary from a set of long options.
Trait Implementations§
Auto Trait Implementations§
impl RefUnwindSafe for Options
impl Send for Options
impl Sync for Options
impl Unpin for Options
impl UnwindSafe for Options
Blanket Implementations§
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.