Struct Command

pub struct Command {
    pub title: String,
    pub description: String,
    pub usage: String,
    pub executor: Callback,
    pub caller_arg: String,
}

Defines the base information of a command that needs to be delivered

Fields

title: String

The title of the command

description: String

The description of the command

usage: String

The usage of the command

executor: Callback

The function that is executed if the command should be executed

caller_arg: String

The argument that indicates if the command should be executed

Implementations

impl Command

pub fn new( title: String, description: String, usage: String, executor: Callback, caller_arg: String, ) -> Self

Creates a new command from the provided values

Examples found in repository

examples/pong_default.rs (lines 18-24)

fn main() {

    // defines the base command
    let pong_command = Command::new(
        "Pong".to_string(),
        "Pong command".to_string(),
        "usage".to_string(),
        executor,
        "ping".to_string()
    );

    let mut runner = Runner::new();
    runner.enable_command_handler(CommandHandlerArguments {
        commands: vec![pong_command],
        default_no_argument_callback: None,
        flags: vec![]
    });
     runner.run();
}

examples/flag_values.rs (lines 14-20)

fn main() {

    let command = Command::new(
        "Test".to_string(),
        "test command".to_string(),
        "normal usage".to_string(),
        executor,
        "test".to_string()
    );

    let flag = Flag::new(
        "testFlag".to_string(),
        vec!["tf".to_string()],
        true
    );


    let mut runner = Runner::new();
    runner.enable_command_handler(CommandHandlerArguments {
        commands: vec![command],
        default_no_argument_callback: None,
        flags: vec![flag]
    });
    runner.run();
}

examples/flags.rs (lines 14-20)

fn main() {

    let command = Command::new(
        "Test".to_string(),
        "test command".to_string(),
        "normal usage".to_string(),
        executor,
        "test".to_string()
    );

    let flag = Flag::new(
        "testFlag".to_string(),
        vec!["tf".to_string()],
        false
    );


    let mut runner = Runner::new();
    runner.enable_command_handler(CommandHandlerArguments {
        commands: vec![command],
        default_no_argument_callback: None,
        flags: vec![flag]
    });
    runner.run();
}

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.