Struct ap::App

pub struct App<'a> { /* fields omitted */ }

The main object used to represent the program.

All consumers of the crate need to create a single object of this type.

Implementations

impl<'a> App<'a>

pub fn new(name: &str) -> Self

Create a new application object.

pub fn args(self, args: Args) -> Self

Specify a set of argument handlers to parse the command-line with.

pub fn version(self, version: &str) -> Self

Specify the version of the program.

pub fn summary(self, summary: &str) -> Self

Specify brief explanatory text for the program.

pub fn help(self, help: &str) -> Self

Specify extended usage information for the program.

pub fn notes(self, notes: &str) -> Self

Specify notes for the program.

pub fn settings(self, settings: Settings) -> Self

Specify any settings for the program.

pub fn ignore_unknown_options(self) -> Self

If set, don’t error if unknown options are specified - just ignore them.

Note

This is an alternative to calling the settings() method.

pub fn ignore_unknown_posn_args(self) -> Self

If set, don’t error if unknown positional arguments are specified - just ignore them.

Note

This is an alternative to calling the settings() method.

pub fn no_strict_options(self) -> Self

If set, disallow option values from starting with as dash.

See the Settings method of the same name for full details and an example showing the effect of this call.

Note

This is an alternative to calling the settings() method.

pub fn generate_help<W>(&self, writer: &mut W) -> Result<()> where
    W: Write + Send + Sync + 'static, 

Generate a help/usage statement from the registered Arg’s.

This is called automatically when the user specifies -h anywhere on the command line; you do not need to register an Arg for -h.

pub fn parse_with_args(&mut self, cli_args: Vec<String>) -> Result<()>

Parse a set of command line arguments (without the program name).

Arguments

• cli_args: Vector of string arguments. Specify your own, or call get_args().

Notes

• The cli_args vector must not specify the command name (which by default is returned as the first element by env::args().collect() for example. Use get_args() as this handles this for you.

pub fn handler(self, boxed_handler: Box<dyn Handler + 'a>) -> Self

Specify the handler for the option which must implement the Handler trait.

Note

If the handler needs to modify its own state when called, the specified boxed trait must provide a mutable reference.

pub fn parse(&mut self) -> Result<()>

Simplest interface to the parser.

Trait Implementations

impl<'a> Clone for App<'a>

fn clone(&self) -> App<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for App<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for App<'a>

fn default() -> App<'a>

Returns the “default value” for a type.

impl<'a> PartialEq<App<'a>> for App<'a>

fn eq(&self, other: &App<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &App<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for App<'a>