Struct Config

pub struct Config { /* private fields */ }

Specifies a configuration of parsed arguments Each option which was given as a spec can be accessed by option(name) This returns a Option<Vec> containing the values of the option (if any)

Implementations

impl Config

Parses and generates configuration from supplied arguments and option specifications Can also generate usage strings

pub fn new_env(specs: &[OptionSpec]) -> Result<Config, String>

Same as Config::new but uses the arguments passed to the program (env::args) The program path, first argument, is included in the unnamed args
Note, the spec isn’t stored with config

pub fn new(args: &[&str], specs: &[OptionSpec]) -> Result<Config, String>

Parses config from custom supplied arguments
Specs is a list containing specifications for the available options a use can supply
Returns Err(msg) if a spec doesn’t match what is specified
The arguments before any option are specified with the (unnamed)
The values for the options can be accessed with the option(name) method
Parsing will fail if an option with policy other than Exact(0) is used twice Note, the spec isn’t stored with config

pub fn generate_usage( specs: &[OptionSpec], list_required: bool, list_unrequired: bool, ) -> String

Generates a usage string from supplied specs

pub fn command(&self) -> &String

Returns the command, I.e; the first argument

pub fn option(&self, name: &str) -> Option<&[String]>

Returns the value[s] given to named or unnamed argument Returns None if argument didn’t exist