Struct CommandSpec 

pub struct CommandSpec {
    pub name: String,
    pub about: Option<String>,
    pub aliases: Vec<String>,
    pub options: Vec<OptionSpec>,
    pub positionals: Vec<PositionalSpec>,
    pub subcommands: Vec<CommandSpec>,
    pub subcommand_required: bool,
    pub after_help: Option<String>,
    pub stability: Stability,
}

A command and (recursively) its subcommands. The single source consumed by the parser, the help renderer, and the completion-tree builder.

Fields

name: String

about: Option<String>

aliases: Vec<String>

options: Vec<OptionSpec>

positionals: Vec<PositionalSpec>

subcommands: Vec<CommandSpec>

subcommand_required: bool

When true, a subcommand must be given (a group command).

after_help: Option<String>

Free-form text appended after the options block in --help (examples, notes). From #[command(after_help/after_long_help = …)].

stability: Stability

Maturity tier (see crate::Stability) — governs whether this command is offered during completion. From #[command(stability = "…")]. Defaults to Stable.

Implementations

impl CommandSpec

pub fn new(name: impl Into<String>) -> Self

pub fn about(self, a: impl Into<String>) -> Self

pub fn alias(self, a: impl Into<String>) -> Self

Add an alternate name this command also answers to (e.g. ls for list).

pub fn after_help(self, a: impl Into<String>) -> Self

pub fn stability(self, s: Stability) -> Self

Declare this command’s maturity tier (see crate::Stability).

pub fn option(self, o: OptionSpec) -> Self

pub fn positional(self, p: PositionalSpec) -> Self

pub fn subcommand(self, c: CommandSpec) -> Self

Trait Implementations

impl Clone for CommandSpec

fn clone(&self) -> CommandSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandSpec

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

Formats the value using the given formatter.

impl Default for CommandSpec

fn default() -> CommandSpec

Returns the “default value” for a type.