Struct shi::command::basic::BasicCommand

pub struct BasicCommand<'a, S> { /* fields omitted */ }

A BasicCommand is a very simple command type. It has a name, and it has a closure that it executes when it is invoked. The closure takes a state, as determined by its containing shell, and a vector of String arguments.

Implementations

impl<'a, S> BasicCommand<'a, S>

pub fn new<F>(name: &'a str, exec: F) -> BasicCommand<'a, S> where
    F: Fn(&mut S, &[String]) -> Result<String> + 'static, 

Creates a new BasicCommand with the given name and closure.

Arguments

• name - The name of the command. This is how users will execute the command.
• exec - The closure that will be executed when this command is invoked.

pub fn new_with_help<F>(
    name: &'a str,
    help: &'a str,
    exec: F
) -> BasicCommand<'a, S> where
    F: Fn(&mut S, &[String]) -> Result<String> + 'static, 

Creates a new BasicCommand with the given name, closure and help message.

Arguments

• name - The name of the command. This is how users will execute the command.
• exec - The closure that will be executed when this command is invoked.
• help - The help message to use.

Trait Implementations

impl<'a, S> BaseCommand for BasicCommand<'a, S>

type State = S

The State of the command. Expected to be bound to a containing Shell.

fn name(&self) -> &str

Returns the name of the command. This is equivalent to how the command would be invoked.

fn validate_args(&self, _: &[String]) -> Result<()>

Validates the given arguments, returning a Result<()> indicating the result of validation.

fn execute(&self, state: &mut S, args: &[String]) -> Result<String>

Executes the command.

fn help(&self) -> String

Returns a String representing the help text of this command. By default, returns nothing.

fn autocomplete(&self, _args: Vec<&str>, _trailing_space: bool) -> Completion

Autocompletes a command, given arguments.