pub trait StructOpt {
fn clap<'a, 'b>() -> App<'a, 'b>;
fn from_clap(_: &ArgMatches<'_>) -> Self;
fn from_args() -> Self
where
Self: Sized,
{ ... }
fn from_iter<I>(iter: I) -> Self
where
Self: Sized,
I: IntoIterator,
I::Item: Into<OsString> + Clone,
{ ... }
fn from_iter_safe<I>(iter: I) -> Result<Self, Error>
where
Self: Sized,
I: IntoIterator,
I::Item: Into<OsString> + Clone,
{ ... }
}
Expand description
A struct that is converted from command line arguments.
Required Methods
sourcefn from_clap(_: &ArgMatches<'_>) -> Self
fn from_clap(_: &ArgMatches<'_>) -> Self
Creates the struct from clap::ArgMatches
. It cannot fail
with a parameter generated by clap
by construction.
Provided Methods
sourcefn from_args() -> Selfwhere
Self: Sized,
fn from_args() -> Selfwhere
Self: Sized,
Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.
sourcefn from_iter<I>(iter: I) -> Selfwhere
Self: Sized,
I: IntoIterator,
I::Item: Into<OsString> + Clone,
fn from_iter<I>(iter: I) -> Selfwhere
Self: Sized,
I: IntoIterator,
I::Item: Into<OsString> + Clone,
Gets the struct from any iterator such as a Vec
of your making.
Print the error message and quit the program in case of failure.
sourcefn from_iter_safe<I>(iter: I) -> Result<Self, Error>where
Self: Sized,
I: IntoIterator,
I::Item: Into<OsString> + Clone,
fn from_iter_safe<I>(iter: I) -> Result<Self, Error>where
Self: Sized,
I: IntoIterator,
I::Item: Into<OsString> + Clone,
Gets the struct from any iterator such as a Vec
of your making.
Returns a clap::Error
in case of failure. This does not exit in the
case of --help
or --version
, to achieve the same behavior as
from_iter()
you must call .exit()
on the error value.