Struct Program

pub struct Program {
    pub cmds: Vec<Command>,
    pub version: String,
    pub author: String,
    pub about: String,
}

The crux of the whole cli, contains a commands field that stores all the program commands in a vector

Fields

cmds: Vec<Command>

Holds all the possible commands of the program

version: String

Contains the version information of the program

author: String

Contains the author’s name

about: String

A simple string containing the tagline of the program

Implementations

impl Program

pub fn new() -> Self

Creates a new instance of the program with an empty vector for the cmds field

pub fn add_cmd() -> Command

This method is used to register a new command to the program

impl Program

pub fn init(&mut self)

This function is called when the program starts, it creates all the commands of the program.

pub fn parse(&mut self, args: &Vec<String>) -> Option<Vec<&Command>>

pub fn validate_args(arguments: &Vec<String>, cmds: &Vec<Command>) -> bool

pub fn output_help(cmds: &Vec<Command>, err: &str)

Outputs help for the program, and prints the error if any is passed

pub fn output_version()

Simply prints the version information for the program

pub fn output_command_help(cmd: &Command, err: &str)

Outputs help information for a speficic command and prints an optional error

Trait Implementations

impl Default for Program

fn default() -> Self

Returns the “default value” for a type.