Struct climake::CLIMake

pub struct CLIMake {
    pub name: String,
    pub description: Option<String>,
    pub args: Vec<Argument>,
    pub none_run: Option<Box<dyn Fn()>>,
}

Main structure for climake, the CLIMake object. Further arguments can easily be added using CLIMake::add_existing_arg.

Fields

name: String

Name of overall CLI

description: Option<String>

Description of CLI (if any)

args: Vec<Argument>

Arguments included

none_run: Option<Box<dyn Fn()>>

An optional run parameter if no arguments are passed. If this is Option::None and no arguments are passed, climake will default to CLIMakeError::NoArgumentsPassed.

Methods

impl CLIMake

pub fn parse_args(&mut self)

Parses arguments given from the avalible CLIMake::args and runs the corrosponding tasks in order.

NOTE: This function will eventually close the program running using std::process.

pub fn add_existing_arg(
    &mut self,
    new_arg: Argument
) -> Result<(), CLIMakeError>

Adds a new argument to parser.

pub fn help_msg(&self) -> String

Displays help message in stdout using added arguments.