Struct foropts::Config

pub struct Config<'a, T> { /* fields omitted */ }

The configuration for the argument parser.

Parameters

<'a> – The lifetime of the arguments’ actions

<T> – The result type that each argument will be parsed into

Methods

impl<'a, T> Config<'a, T>

pub fn new<S: Into<String>>(name: S) -> Self

Creates a new foropts::Builder given the name of the program.

pub fn name<S: Into<String>>(self, name: S) -> Self

Sets the program name.

pub fn version<S: Into<String>>(self, version: S) -> Self

Sets the version string.

pub fn author<S: Into<String>>(self, author: S) -> Self

Sets the author string.

pub fn about<S: Into<String>>(self, about: S) -> Self

Sets the description string.

pub fn arg_safe(&mut self, arg: Arg<'a, T>) -> Result<()>

Adds an argument to the list of arguments, returning Result::Err if the argument cannot be added.

pub fn arg(self, arg: Arg<'a, T>) -> Self

Adds an argument to the list of arguments.

Panics

Panics if the argument cannot be added.

pub fn args<I: IntoIterator<Item = Arg<'a, T>>>(self, args: I) -> Self

Adds arguments to the list of arguments.

Panics

Panics if an argument cannot be added.

Important traits for Iter<'a, 'b, I, T>

impl<'a, 'b, I, T> Iterator for Iter<'a, 'b, I, T> where
    I: IntoIterator<Item = String>,  type Item = Result<T>;

pub fn iter<'b, I: IntoIterator<Item = String>>(
    &'b self,
    args: I
) -> Iter<'b, 'a, I, T>

Given an iterator over the unparsed arguments, returns an iterator over the parsed arguments.

pub fn exit_error(&self, error: &Error) -> !

Exits with an error message and usage information printed on stderr, with exit code 1.

pub fn exit_usage(&self) -> !

Prints usage information to stdout and exits with code 0.

pub fn exit_version(&self) -> !

Prints version information to stdout and exits with code 0.

pub fn write_version<W: Write>(&self, out: W) -> Result<()>

Writes version information to the given Write.

pub fn write_usage<W: Write>(&self, out: W) -> Result<()>

Writes usage information to the given Write.

Trait Implementations

impl<'a, T: Debug> Debug for Config<'a, T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.