Trait otter_api_tests::StructOpt [−][src]
pub trait StructOpt { pub fn clap<'a, 'b>() -> App<'a, 'b>; pub fn from_clap(matches: &ArgMatches<'_>) -> Self; pub fn from_args() -> Self { ... } pub fn from_args_safe() -> Result<Self, Error> { ... } pub fn from_iter<I>(iter: I) -> Self
where
I: IntoIterator,
<I as IntoIterator>::Item: Into<OsString>,
<I as IntoIterator>::Item: Clone, { ... } pub fn from_iter_safe<I>(iter: I) -> Result<Self, Error>
where
I: IntoIterator,
<I as IntoIterator>::Item: Into<OsString>,
<I as IntoIterator>::Item: Clone, { ... } }
A struct that is converted from command line arguments.
Required methods
pub fn clap<'a, 'b>() -> App<'a, 'b>
[src]
Returns clap::App
corresponding to the struct.
pub fn from_clap(matches: &ArgMatches<'_>) -> Self
[src]
Builds the struct from clap::ArgMatches
. It’s guaranteed to succeed
if matches
originates from an App
generated by StructOpt::clap
called on
the same type, otherwise it must panic.
Provided methods
pub fn from_args() -> Self
[src]
Builds the struct from the command line arguments (std::env::args_os
).
Calls clap::Error::exit
on failure, printing the error message and aborting the program.
pub fn from_args_safe() -> Result<Self, Error>
[src]
Builds the struct from the command line arguments (std::env::args_os
).
Unlike StructOpt::from_args
, returns clap::Error
on failure instead of aborting the program,
so calling .exit
is up to you.
pub fn from_iter<I>(iter: I) -> Self where
I: IntoIterator,
<I as IntoIterator>::Item: Into<OsString>,
<I as IntoIterator>::Item: Clone,
[src]
I: IntoIterator,
<I as IntoIterator>::Item: Into<OsString>,
<I as IntoIterator>::Item: 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.
NOTE: The first argument will be parsed as the binary name unless
clap::AppSettings::NoBinaryName
has been used.
pub fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
I: IntoIterator,
<I as IntoIterator>::Item: Into<OsString>,
<I as IntoIterator>::Item: Clone,
[src]
I: IntoIterator,
<I as IntoIterator>::Item: Into<OsString>,
<I as IntoIterator>::Item: 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.
NOTE: The first argument will be parsed as the binary name unless
clap::AppSettings::NoBinaryName
has been used.
Implementations on Foreign Types
impl<T> StructOpt for Box<T, Global> where
T: StructOpt,
[src]
T: StructOpt,
pub fn clap<'a, 'b>() -> App<'a, 'b>
[src]
pub fn from_clap(matches: &ArgMatches<'_>) -> Box<T, Global>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
A: Allocator,
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;
[src]
Notable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
A: Allocator,
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;