Struct CLIParser

pub struct CLIParser {
    pub posits: Vec<String>,
    pub flags: HashSet<String>,
    pub pairs: HashMap<String, String>,
}

Fields

posits: Vec<String>

Positional arguments.

These are the standard arguments without any special syntax.

Example:

./my_program posit_argument_1 posit_argument_2

flags: HashSet<String>

Flags.

These arguments are prefixed with a singular dash line. They are unique, unordered and don’t take any values.

Example:

./my_program -test_mode -verbose

pairs: HashMap<String, String>

Key - value pairs.

These arguments are prefixed with a double dash line. They need to be connected to their value with an equal sign.

Example

./my_program --debug_level=2 --id=5 --name="John Smith"

Implementations

impl CLIParser

pub fn new() -> Self

Creates a new cli-parser object, with empty data structures.

pub fn init(self) -> Result<Self, CLIError>

Parses the std::env::args() and collects them into data structures.

Will throw error if CLI arguments are considered malformed by this crate.

// Initialize parser
let parser = cliparser::CLIParser::new().init().unwrap();
 
// Extract parsed data structures
let posit_arguments = parser.posits.clone(); // Vector
let flags = parser.flags.clone(); // HashSet
let pairs = parser.pairs.clone(); // HashMap

Trait Implementations

impl Clone for CLIParser

fn clone(&self) -> CLIParser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CLIParser

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

Formats the value using the given formatter.

impl Default for CLIParser

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CLIParser

fn eq(&self, other: &CLIParser) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CLIParser

impl StructuralPartialEq for CLIParser