Expand description
Re-export of clap
Macros
Counts the number of comma-delimited expressions passed to it. The result is a compile-time
evaluable expression, suitable for use as a static array size, or the value of a
const
.Allows you to build the
App
instance from your Cargo.toml at compile time.Build
App
, Arg
s, SubCommand
s and Group
s with Usage-string like input
but without the associated parsing runtime cost.Allows you to pull the authors for the app from your Cargo.toml at
compile time in the form:
"author1 lastname <author1@example.com>:author2 lastname <author2@example.com>"
Allows you to pull the description from your Cargo.toml at compile time.
Allows you to pull the name from your Cargo.toml at compile time.
Allows you to pull the version from your Cargo.toml at compile time as
MAJOR.MINOR.PATCH_PKGVERSION_PRE
Convenience macro getting a typed value
T
where T
implements std::str::FromStr
from an
argument value. This macro returns a Result<T,String>
which allows you as the developer to
decide what you’d like to do on a failed parse. There are two types of errors, parse failures
and those where the argument wasn’t present (such as a non-required argument). You can use
it to get a single value, or a iterator as with the ArgMatches::values_of
Convenience macro getting a typed value
T
where T
implements std::str::FromStr
or
exiting upon error, instead of returning a Result
type.Convenience macro getting a typed value
Vec<T>
where T
implements std::str::FromStr
This macro returns a clap::Result<Vec<T>>
which allows you as the developer to decide
what you’d like to do on a failed parse.Convenience macro getting a typed value
Vec<T>
where T
implements std::str::FromStr
or exiting upon error.Structs
Used to create a representation of a command line program and all possible command line
arguments. Application settings are set using the “builder pattern” with the
App::get_matches
family of methods being the terminal methods that starts the
runtime-parsing process. These methods then return information about the user supplied
arguments (or lack there of).The abstract representation of a command line argument. Used to set all the options and
relationships that define a valid argument for the program.
ArgGroup
s are a family of related arguments and way for you to express, “Any of these
arguments”. By placing arguments in a logical group, you can create easier requirement and
exclusion rules instead of having to list each argument individually, or when you want a rule
to apply “any but not all” arguments.Used to get information about the arguments that were supplied to the program at runtime by
the user. New instances of this struct are obtained by using the
App::get_matches
family of
methods.Command Line Argument Parser Error
An iterator for getting multiple values out of an argument via the
ArgMatches::values_of_os
method. Usage of this iterator allows values which contain invalid UTF-8 code points unlike
Values
.The abstract representation of a command line subcommand.
An iterator for getting multiple values out of an argument via the
ArgMatches::values_of
method.Enums
Application level settings, which affect how
App
operatesVarious settings that apply to arguments and may be set, unset, and checked via getter/setter
methods
Arg::set
, Arg::unset
, and Arg::is_set
Command line argument parser kind of error
Describes which shell to produce a completions file for