Struct ArgParseResults

pub struct ArgParseResults { /* private fields */ }

This type represents the result ofparsing arguments.

Implementations

impl ArgParseResults

pub fn get<T: FromStr>(&self, name: &str) -> Option<T>

Extracts the argument, as long is the value type implements FromStr

Example

use argparse::{ArgParser, ArgType};

let mut parser = ArgParser::new("runner".into());
parser.add_opt("verbose", Some("false"), 'v', false,
    "Whether to produce verbose output", ArgType::Flag);

// Normally you'd get this from std::env::args().iter()
let test_1 = "./runner -v".split_whitespace()
    .map(|s| s.into())
    .collect::<Vec<String>>();
 
if let Ok(p_res) = parser.parse(test_1.iter()) {
    if let Some(true) = p_res.get::<bool>("verbose") {
        // be verbose
    }
}

pub fn get_with<T, P>(&self, name: &str, parser: P) -> Option<T>

where P: ArgGetter<T>,

Extracts the argument, using the ArgGetter<T> that you provided

Note

See documentation for the trait ArgGetter for more information

Example

use argparse::{ArgParser, ArgType};

let mut parser = ArgParser::new("runner".into());
parser.add_opt("verbose", Some("false"), 'v', false,
    "Whether to produce verbose output", ArgType::Flag);

// Normally you'd get this from std::env::args().iter()
let test_1 = "./runner -v".split_whitespace()
    .map(|s| s.into())
    .collect::<Vec<String>>();
 
let dumb_closure = |_: &str| { Some(true) };
 
if let Ok(p_res) = parser.parse(test_1.iter()) {
    if let Some(true) = p_res.get_with::<bool, _>("verbose", dumb_closure) {
        // be verbose
    }
}

Trait Implementations

impl Clone for ArgParseResults

fn clone(&self) -> ArgParseResults

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgParseResults

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

Formats the value using the given formatter.