Struct Command

pub struct Command {
    pub name: String,
    pub alias: String,
    pub description: String,
    pub options: Vec<Flag>,
    pub callback: fn(_: &Command, _: &Vec<String>),
}

The structure of a command in the program

Fields

name: String

The name of the command i.e up, start, run

alias: String

Any alias given to the command, normally a single letter, u, i, s

description: String

A simple description of the command, gets output when the –help flag is passed

options: Vec<Flag>

Options are the flags that can be passed to the specified command i.e -q –priority

callback: fn(_: &Command, _: &Vec<String>)

Implementations

impl Command

Methods for command mutation

pub fn command(&mut self, name: &str) -> &mut Command

Changes the name of a command to the passed value

pub fn alias(&mut self, val: &str) -> &mut Command

Mutates the alias of the command to which it is attached

pub fn describe(&mut self, desc: &str) -> &mut Command

Edits the description of a command, setting it to the passed value

pub fn option(&mut self, body: &str) -> &mut Command

Pushes new options to the options vector of a command

pub fn build(&mut self, prog: &mut Program)

pub fn action(&mut self, cb: fn(_: &Command, _: &Vec<String>)) -> &mut Command

pub fn parse()

impl Command

pub fn new() -> Self

Returns a new instance of an empty command for its values to be modified

pub fn init(&self, _args: &Vec<String>)

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Command

fn default() -> Self

Returns the “default value” for a type.