Struct Parser

pub struct Parser<'a> { /* private fields */ }

The command line parser.

Implementations

impl<'a> Parser<'a>

pub fn new() -> Parser<'a>

Return a new parser.

pub fn opt<T>(&mut self, var: T) -> &mut Opt<'a>

where T: 'a + CommandLineArgument,

Add and return an option.

• var is the associated variable

pub fn param<T>(&mut self, var: T) -> &mut Param<'a>

where T: 'a + CommandLineArgument,

Add and return a parameter.

• var is the associated variable

pub fn auto_shorts(&mut self, auto_shorts: bool)

Set whether short options should be generated automatically.

pub fn stop_on(&mut self, stopon: &'a str)

Specify an additional stop string.

pub fn command_name(&mut self, command_name: &'a str)

Set the command name.

pub fn usage(&mut self, usage: &'a str)

Set the usage string.

pub fn synopsis(&mut self, synopsis: &'a str)

Set the synopsis string.

pub fn version(&mut self, version: &'a str)

Set the version string.

pub fn help(&mut self, help: bool)

Add help option.

pub fn parse<'b, I>(&mut self, args: I) -> Result<Vec<&'b str>, Error>

where I: IntoIterator<Item = &'b str>,

Parse vector of command line arguments.

Returns a vector of remaining (unparsed) arguments.

pub fn write_usage(&self, output: &mut dyn Write) -> Result<(), Error>

Write the usage string to some output stream.

Trait Implementations

impl<'a> Default for Parser<'a>

fn default() -> Self

Returns the “default value” for a type.