Struct Command

pub struct Command<'a> {
    pub description: String,
    pub args_info: Vec<String>,
    pub handler: Box<Handler<'a>>,
}

Single command that can be called in the REPL.

Though it is possible to construct it by manually, it is not advised. One should rather use the provided [command!] macro which will generate appropriate arguments validation and args_info based on passed specification.

Fields

description: String

Command desctiption that will be displayed in the help message

args_info: Vec<String>

Names and types of arguments to the command

handler: Box<Handler<'a>>

Command handler which should validate arguments and perform command logic

Implementations

impl<'a> Command<'a>

pub fn run(&mut self, args: &[&str]) -> Result<CommandStatus>

Validate the arguments and invoke the handler if arguments are correct.

pub fn arg_types(&self) -> Vec<&str>

Returns the string description of the argument types

Trait Implementations

impl<'a> Debug for Command<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.