Struct Parser

pub struct Parser { /* private fields */ }

A struct that parses the command line for certain Args.

Example

let parser = Parser::new();
let arg = Arg::new().param("num");
let mut args = std::env::args();
args.next();
 
parser.add_arg(arg);
let output = parser.parse(&mut args).unwrap();

Implementations

impl Parser

pub fn new() -> Parser

Creates a new Parser struct.

Example

let parser = Parser::new();

pub fn add_arg(&self, arg: Arg)

Adds an argument to the parser.

Example

let arg = Arg::new().param("num");
let parser = Parser::new();
 
parser.add_arg(arg);

pub fn add_args(&self, args: Vec<Arg>)

Adds a vector of arguments to the parser.

Example

let mut args = vec![
    Arg::new().param("num1"),
    Arg::new().param("num2"),
];
let parser = Parser::new();
 
parser.add_args(args);

pub fn args(&self) -> Vec<Arg>

Returns the arguments associated with this parser as a vector.

Example

let args = parser.args();

pub fn len(&self) -> usize

Returns the number of arguments associated with this parser.

Example

let n = parser.len();

pub fn parse( &self, args: &mut impl Iterator<Item = String>, ) -> Result<HashMap<String, Option<String>>, Box<dyn Error>>

Parses through the remaining arguments and returns a hashmap of arguments passed and their relevant values.

Example

let parser = Parser::new();
let mut args = vec![
    Arg::new().param("p1"),
    Arg::new().param("p2"),
    Arg::new().flag("help").short('h');
];
parser.add_args(args);
 
let mut input_args = std::env::args();
input_args.next();
 
let hashmap = parser.parse(input_args).unwrap();
println!("p1: {}, p2: {}", hashmap.get("p1"), hashmap.get("p2"));
if hashmap.contains_key("help") {
    println!("Help requested!");
}