A module which provides a way to specify descriptions and * groups of short and long option names, together.
OptGroup
- one group of options, eof core::cmp::Eq for OptGroup
getopts
long_to_short
optflag
- Create a long option that is optional and does not take an argumentoptflagopt
- Create a long option that is optional and takes an optional argumentoptmulti
- Create a long option that is optional, takes an argument, and may occur multiple timesoptopt
- Create a long option that is optional and takes an argumentreqopt
- Create a long option that is required and takes an argumentusage
- Derive a usage message from a set of long optionsOptGroup
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
core::cmp::Eq
for OptGroup
eq
fn eq(__other: &OptGroup) -> bool
ne
fn ne(__other: &OptGroup) -> bool
getopts
fn getopts(args: &[~str], opts: &[OptGroup]) -> Result
long_to_short
fn long_to_short(lopt: &OptGroup) -> ~[Opt]
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
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
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
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
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
usage
fn usage(brief: &str, opts: &[OptGroup]) -> ~str
Derive a usage message from a set of long options