Struct qargparser::Builder

pub struct Builder { /* fields omitted */ }

Parser option/argument specification builder.

Implementations

impl Builder

pub fn new() -> Self

pub fn sopt(&mut self, sopt: char) -> &mut Self

Make argument specification a single-character option.

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

Make argument specification a long option name.

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

Assign argument specification a name. This is required for positional arguments.

pub fn nargs<I, S>(&mut self, nargs: Nargs, metanames: I) -> &mut Self where
    I: IntoIterator<Item = S>,
    S: AsRef<str>, 

Declare that this argument specification takes arguments.

pub fn metanames<I, S>(&mut self, metanames: I) -> &mut Self where
    I: IntoIterator<Item = S>,
    S: AsRef<str>, 

Assign meta-names to the arguments.

pub fn exit(&mut self, exit: bool) -> &mut Self

Specify if encountering this argument specification should terminate the parser.

This is useful for options that should terminate normal program behavor, such as --help or if a positional argumen has been encountered which should abort the parser because the rest of the arguments should be parsed by a different parser.

pub fn required(&mut self, req: bool) -> &mut Self

Tell the parser that the argument must be processed. This is only useful for positional arguments.

pub fn hidden(&mut self, hidden: bool) -> &mut Self

Hidden arguments exist and work as usual, but they are not displayed in the help screen.

pub fn help<I, S>(&mut self, text: I) -> &mut Self where
    I: IntoIterator<Item = S>,
    S: AsRef<str>, 

pub fn build<C>(
    &self,
    proc: fn(spec: &Spec<C>, ctx: &mut C, args: &Vec<String>)
) -> Spec<C>