Enum shi::command::Command

pub enum Command<'a, S> {
    Leaf(Box<dyn BaseCommand<State = S> + 'a>),
    Parent(ParentCommand<'a, S>),
}

Command represents all and any command that should exist in shi. It represents a clear bifurcation: a command is either a Leaf or a Parent command.

This refers to tree terminology; a command either has no children (subcommands) or it does. Thus, it is either a Leaf command or a Parent command, respectively.

Variants

Leaf(Box<dyn BaseCommand<State = S> + 'a>)

A command that has no sub commands. Conforms to BaseCommand. Executes, unlike Parent.

Tuple Fields of Leaf

0: Box<dyn BaseCommand<State = S> + 'a>

Parent(ParentCommand<'a, S>)

A command that has sub commands. A ParentCommand does not execute.

Tuple Fields of Parent

0: ParentCommand<'a, S>

Implementations

impl<'a, S> Command<'a, S>

pub fn new_leaf<C>(child_cmd: C) -> Self where
    C: BaseCommand<State = S> + 'a, 

Creates a new Leaf Command from the given command.

pub fn new_parent(name: &'a str, sub_cmds: Vec<Command<'a, S>>) -> Self

Creates a new Parent Command from the given vector of sub commands.

Trait Implementations

impl<'a, S> BaseCommand for Command<'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, args: &[String]) -> Result<()>

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

fn execute(&self, state: &mut Self::State, 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.