Struct ArgvMap

pub struct ArgvMap { /* private fields */ }

A map containing matched values from command line arguments.

The keys are just as specified in Docopt: --flag for a long flag or -f for a short flag. (If -f is a synonym for --flag, then either key will work.) ARG or <arg> specify a positional argument and cmd specifies a command.

Implementations

impl ArgvMap

pub fn deserialize<'de, T: Deserialize<'de>>(self) -> Result<T, Error>

Tries to deserialize the map of values into a struct.

This method should always be called to deserialize a ArgvMap into a struct. All fields of the struct must map to a corresponding key in the ArgvMap. To this end, each member must have a special prefix corresponding to the different kinds of patterns in Docopt. There are three prefixes: flag_, arg_ and cmd_ which respectively correspond to short/long flags, positional arguments and commands.

If a Docopt item has a - in its name, then it is converted to an _.

Example

use serde::Deserialize;

use docopt::Docopt;

const USAGE: &'static str = "
Usage: cargo [options] (build | test)
       cargo --help

Options: -v, --verbose
         -h, --help
";

#[derive(Deserialize)]
struct Args {
  cmd_build: bool,
  cmd_test: bool,
  flag_verbose: bool,
  flag_h: bool,
}

let argv = || vec!["cargo", "build", "-v"].into_iter();
let args: Args = Docopt::new(USAGE)
    .and_then(|d| d.argv(argv()).deserialize())
    .unwrap_or_else(|e| e.exit());
assert!(args.cmd_build && !args.cmd_test
        && args.flag_verbose && !args.flag_h);

Note that in the above example, flag_h is used but flag_help could also be used. (In fact, both could be used at the same time.)

In this example, only the bool type was used, but any type satisfying the Deserialize trait is valid.

pub fn get_bool(&self, key: &str) -> bool

Finds the value corresponding to key and calls as_bool() on it. If the key does not exist, false is returned.

Examples found in repository

examples/hashmap.rs (line 34)

fn main() {
    let version = "1.2.3".to_owned();
    let args = Docopt::new(USAGE)
                      .and_then(|dopt| dopt.version(Some(version)).parse())
                      .unwrap_or_else(|e| e.exit());
    println!("{:?}", args);

    // You can conveniently access values with `get_{bool,count,str,vec}`
    // functions. If the key doesn't exist (or if, e.g., you use `get_str` on
    // a switch), then a sensible default value is returned.
    println!("\nSome values:");
    println!("  Speed: {}", args.get_str("--speed"));
    println!("  Drifting? {}", args.get_bool("--drifting"));
    println!("  Names: {:?}", args.get_vec("<name>"));
    println!("  Command 'ship' invoked? {:?}", args.get_bool("ship"));
}

pub fn get_count(&self, key: &str) -> u64

Finds the value corresponding to key and calls as_count() on it. If the key does not exist, 0 is returned.

pub fn get_str(&self, key: &str) -> &str

Finds the value corresponding to key and calls as_str() on it. If the key does not exist, "" is returned.

Examples found in repository

examples/hashmap.rs (line 33)

fn main() {
    let version = "1.2.3".to_owned();
    let args = Docopt::new(USAGE)
                      .and_then(|dopt| dopt.version(Some(version)).parse())
                      .unwrap_or_else(|e| e.exit());
    println!("{:?}", args);

    // You can conveniently access values with `get_{bool,count,str,vec}`
    // functions. If the key doesn't exist (or if, e.g., you use `get_str` on
    // a switch), then a sensible default value is returned.
    println!("\nSome values:");
    println!("  Speed: {}", args.get_str("--speed"));
    println!("  Drifting? {}", args.get_bool("--drifting"));
    println!("  Names: {:?}", args.get_vec("<name>"));
    println!("  Command 'ship' invoked? {:?}", args.get_bool("ship"));
}

pub fn get_vec(&self, key: &str) -> Vec<&str>

Finds the value corresponding to key and calls as_vec() on it. If the key does not exist, vec!() is returned.

Examples found in repository

examples/hashmap.rs (line 35)

fn main() {
    let version = "1.2.3".to_owned();
    let args = Docopt::new(USAGE)
                      .and_then(|dopt| dopt.version(Some(version)).parse())
                      .unwrap_or_else(|e| e.exit());
    println!("{:?}", args);

    // You can conveniently access values with `get_{bool,count,str,vec}`
    // functions. If the key doesn't exist (or if, e.g., you use `get_str` on
    // a switch), then a sensible default value is returned.
    println!("\nSome values:");
    println!("  Speed: {}", args.get_str("--speed"));
    println!("  Drifting? {}", args.get_bool("--drifting"));
    println!("  Names: {:?}", args.get_vec("<name>"));
    println!("  Command 'ship' invoked? {:?}", args.get_bool("ship"));
}

pub fn find(&self, key: &str) -> Option<&Value>

Return the raw value corresponding to some key.

key should be a string in the traditional Docopt format. e.g., <arg> or --flag.

pub fn len(&self) -> usize

Return the number of values, not including synonyms.

Trait Implementations

impl Clone for ArgvMap

fn clone(&self) -> ArgvMap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArgvMap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.