Struct easy_args::args::Args

pub struct Args { /* fields omitted */ }

Holds all the command-line arguments given by the user.

Each argument is contained within a HashMap that can be index by the argument’s name.

Implementations

impl Args

pub fn is_set(&self, name: impl Into<String>) -> bool

Determines if an argument of a given name was set by the user in the command-line.

Example

if args.is_set("window-height") {
    resize_window(args.integer("window-height").unwrap());
}

pub fn boolean(&self, name: impl Into<String>) -> Option<&bool>

Returns a reference to the boolean value that corresponds with the given argument name.

Example

if args.boolean("windowed") == Some(&true) {
    set_windowed_mode();
}

pub fn integer(&self, name: impl Into<String>) -> Option<&i64>

Returns a reference to the i64 value that corresponds with the given argument name.

Example

let num_leaves_in_pile = *args.integer("leaves").unwrap_or(&0);

pub fn unsigned_integer(&self, name: impl Into<String>) -> Option<&u64>

Returns a reference to the u64 value that corresponds with the given argument name.

Example

let size = *args.unsigned_integer("size").unwrap_or(&0);

pub fn string(&self, name: impl Into<String>) -> Option<&String>

Returns a reference to the String value that corresponds with the given argument name.

Exmaple

let username args.string("username").unwrap_or(&"Guest".to_string())

pub fn loan_args(&self) -> &Vec<String>

A Vector of all strings passed as command-line arguments that weren’t arguments of the [ArgSpec].

Example

for arg in args.loan_args() {
    println!("What the heck is this? '{}'.", arg);
}

Trait Implementations

impl Debug for Args

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

Formats the value using the given formatter.