A module which provides a way to specify descriptions and * groups of short and long option names, together.

Struct OptGroup

pub struct OptGroup {
    short_name: ~str,
    long_name: ~str,
    hint: ~str,
    desc: ~str,
    hasarg: HasArg,
    occur: Occur,
}

one group of options, e.g., both -h and --help, along with * their shared description and properties

Implementation of core::cmp::Eq for OptGroup

Method eq

fn eq(__other: &OptGroup) -> bool

Method ne

fn ne(__other: &OptGroup) -> bool

Function getopts

fn getopts(args: &[~str], opts: &[OptGroup]) -> Result

Function long_to_short

fn long_to_short(lopt: &OptGroup) -> ~[Opt]

Function optflag

fn optflag(short_name: &str, long_name: &str, desc: &str) -> OptGroup

Create a long option that is optional and does not take an argument

Function optflagopt

fn optflagopt(short_name: &str, long_name: &str, desc: &str, hint: &str) ->
 OptGroup

Create a long option that is optional and takes an optional argument

Function optmulti

fn optmulti(short_name: &str, long_name: &str, desc: &str, hint: &str) ->
 OptGroup

Create a long option that is optional, takes an argument, and may occur multiple times

Function optopt

fn optopt(short_name: &str, long_name: &str, desc: &str, hint: &str) ->
 OptGroup

Create a long option that is optional and takes an argument

Function reqopt

fn reqopt(short_name: &str, long_name: &str, desc: &str, hint: &str) ->
 OptGroup

Create a long option that is required and takes an argument

Function usage

fn usage(brief: &str, opts: &[OptGroup]) -> ~str

Derive a usage message from a set of long options