Struct xcli::Command

pub struct Command<'a> { /* fields omitted */ }

Command structure, which describes a command and its action.

Implementations

impl<'a> Command<'a>

pub fn new<S: Into<String>>(n: S) -> Self

Create a command

pub fn new_with_alias<S: Into<String>>(n: S, s: S) -> Self

pub fn get_name(&self) -> &str

Get the name of this command.

pub fn get_alias(&self) -> &Option<String>

Get the alias name of this command.

pub fn action(
    mut self: Self,
    action: fn(_: &App<'_>, _: &[&str]) -> XcliResult
) -> Self

Set a CmdAction to this command.

pub fn about<S: Into<&'a str>>(mut self: Self, about: S) -> Self

Set a description to this command.

pub fn usage<S: Into<&'a str>>(mut self: Self, about: S) -> Self

Set the usage to this command.

pub fn get_subcommands(&self) -> &[Command<'a>]

Get all subcommands of this command

pub fn subcommand(mut self: Self, subcmd: Command<'a>) -> Self

Add a subcommand to this command

pub fn subcommands<I>(mut self: Self, subcmds: I) -> Self where
    I: IntoIterator<Item = Command<'a>>, 

Add more than one subcommand to this command, the given subcmds implements IntoIterator

pub fn show_command_usage(&self)

show usage message for command.

pub fn show_command_help(&self)

show help message for command.

pub fn show_subcommand_help(&self)

show help message for command and its subs

pub fn locate_subcommand(&self, args: &[&str]) -> Option<&Command<'_>>

locate the sub command by the args given

pub fn run_sub(&self, app: &App<'_>, args: &[&str]) -> XcliResult

run sub commands

show error message when action not found but with extra args

show help messages when action not found for the sub command

execute sub command when action found

pub fn for_each<F>(&self, path: &str, f: &mut F) where
    F: FnMut(&Self, &str), 

Trait Implementations

impl<'a> Default for Command<'a>

fn default() -> Command<'a>

Returns the "default value" for a type.