Struct climake::CliArgument

pub struct CliArgument {
    pub help_str: &'static str,
    // some fields omitted
}

A single argument in a list of arguments to parse later in CliMake::parse.

Example inititation

let arg_onetwo = CliArgument.new(
    vec!['o', 't'],
    vec!["onetwo"],
    Some("This is some detailed help for onetwo"),
    Box::new(&to_run_for_onetwo)
);

Fields

help_str: &'static str

Inner-command help for a specific argument. See CliArgument::help_msg for a better help representation.

Implementations

impl CliArgument

pub fn new(
    short_calls: Vec<char>,
    long_calls: Vec<&'static str>,
    help: Option<&'static str>,
    run: Box<dyn FnMut(Vec<String>)>
) -> Self

Creates a new argument in a simplistic manner.

pub fn help_msg(&self) -> String

Gives in-depth details and running infomation compared to the plaintext CliArgument::help_str, reccomended to use.

Example results

Both below are taken from the dynamic args example:

Usage: ./dynamic_args [-q, -r, -s, --hi, --second] [CONTENT]

About:
  Simple help

Usage: ./dynamic_args [-a, -b, -c, --other, --thing] [CONTENT]

About:
  Other help