Struct Parser

pub struct Parser<'a> { /* private fields */ }

A command-line argument parser.

Example

use clapi::{Command, CommandOption, Argument, Context, Parser};
use clapi::validator::validate_type;

let command = Command::new("MyApp")
    .option(CommandOption::new("number")
        .arg(Argument::new().validator(validate_type::<i64>())))
    .option(CommandOption::new("enable")
        .requires_assign(true)
        .arg(Argument::new().validator(validate_type::<bool>())));

let context = Context::new(command);
let result = Parser::new(&context)
    .parse(vec!["--number", "25", "--enable=false"])
    .unwrap();

assert_eq!(result.options().get_arg("number").unwrap().convert::<i64>().ok(), Some(25));
assert_eq!(result.options().get_arg("enable").unwrap().convert::<bool>().ok(), Some(false));

Implementations

impl<'a> Parser<'a>

pub fn new(context: &'a Context) -> Self

Constructs a new Parser

pub fn parse<S, I>(&mut self, args: I) -> Result<ParseResult>

where S: Borrow<str>, I: IntoIterator<Item = S>,

Parsers the given arguments and returns the Ok(ParseResult) if the parsing succeed otherwise Err(Error).

Example

use clapi::{Command, Argument, Parser, Context};
let command = Command::new("MyApp")
    .arg(Argument::with_name("value"));

let context = Context::new(command);
let result = Parser::new(&context).parse(vec!["hello world"]).unwrap();
assert_eq!(&result.arg().unwrap()[0], "hello world");

Trait Implementations

impl<'a> Clone for Parser<'a>

fn clone(&self) -> Parser<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Parser<'a>

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

Formats the value using the given formatter.