Struct rargsxd::ArgParser

pub struct ArgParser {
    pub name: String,
    pub author: String,
    pub version: String,
    pub copyright: String,
    pub info: String,
    pub usage: String,
    pub require_args: bool,
    pub extra: Vec<String>,
    // some fields omitted
}

The main class for parsing

Fields

name: String

The name of the program

author: String

The author of the program

version: String

The version of the program

copyright: String

Copyright string

info: String

Simple description of the program

usage: String

Example usage of the program

require_args: bool

Whether the program has to have arguments passed or not

extra: Vec<String>

Any extra arguments that were passed, but not parsed

Implementations

impl ArgParser

pub fn from_argv0() -> Self

Creates a new ArgParser using the first argument (the program) as the name. Creates help and version args by default

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

Creates a new ArgParser, with . Creates help and version args by default

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

Sets the author

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

Sets the version

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

Sets the copyright

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

Sets the info

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

Sets the usage. Replaces all instances of {name} with the program’s name.

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

Sets whether the program needs arguments or not

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

Adds the Vec<&mut Arg> to the parser’s args

pub fn map_argval(&self) -> HashMap<String, ArgVal>

Returns a copy of the parser’s current arguments in HashMap form using the ArgVal struct

pub fn map_tuple(&self) -> HashMap<String, (bool, String)>

Returns a copy of the parser’s current arguments in HashMap form using tuples

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

Gets a String value arg by . If no arg is found, default to String::new()

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

Gets a bool value arg by . If no arg is found, default to false

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

Parse with env::args()

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

Parses a given Vec

Trait Implementations

impl Clone for ArgParser

fn clone(&self) -> ArgParser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgParser

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

Formats the value using the given formatter.