Struct rargsxd::ArgParser

pub struct ArgParser {
    pub extra: Vec<String>,
    // some fields omitted
}

Main parser struct.

Fields

extra: Vec<String>

Implementations

impl ArgParser

pub fn parse(&mut self) -> &mut Self

Parses std::env::args().

pub fn parse_vec(&mut self, args: Vec<String>) -> &mut Self

Parses a given Vec.

pub fn get_option(&self, name: &str) -> Option<String>

Gets an option argument’s output by name.

pub fn get_flag(&self, name: &str) -> Option<bool>

Gets a flag argument’s output by name.

pub fn get_word(&self, name: &str) -> Option<WordType>

Gets a word argument’s output by name.

pub fn new(name: &str) -> Self

Creates a new ArgParser with name &str.

pub fn print_help(&self)

Prints the help dialog.

pub fn name(&mut self, name: &str) -> &mut Self

Sets the name of the program.

pub fn author(&mut self, author: &str) -> &mut Self

Sets the name of the author of the program.

pub fn version(&mut self, version: &str) -> &mut Self

Sets the version of the program.

pub fn copyright(&mut self, copyright: &str) -> &mut Self

Sets the copyright (if any) of the program.

pub fn info(&mut self, info: &str) -> &mut Self

Sets the info of the program.

pub fn usage(&mut self, usage: &str) -> &mut Self

Sets the usage of the program.

pub fn args(&mut self, args: Vec<&mut Arg>) -> &mut Self

Gives the parser args Vec<&mut Arg>.

pub fn require_args(&mut self, require: bool) -> &mut Self

Sets whether or not the program should exit when no arguments are passed.