Struct shi::command::parent::ParentCommand

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

ParentCommand represents a command with subcommands. It has a name, but it does not execute anything itself. It dispatches to the appropriate child command, if one exists.

Implementations

impl<'a, S> ParentCommand<'a, S>

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

Creates a new ParentCommand.

Arguments

name - The name of this command. sub_cmds - The subcommands or children of the ParentCommand to be created.

pub fn new_with_help(
    name: &'a str,
    help: &'a str,
    sub_cmds: Vec<Command<'a, S>>
) -> ParentCommand<'a, S>

Creates a new ParentCommand with the given help message.

Arguments

name - The name of this command. sub_cmds - The subcommands or children of the ParentCommand to be created.

pub fn sub_commands(&self) -> &CommandSet<'_, S>

Returns a CommandSet of the child commands under this ParentCommand.

Trait Implementations

impl<'a, S> BaseCommand for ParentCommand<'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 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.