Struct CommandInfo 

#[non_exhaustive]
pub struct CommandInfo {
    pub name: &'static str,
    pub about: &'static str,
    pub long_about: &'static str,
    pub version: Option<&'static str>,
    pub args: &'static [ArgInfo],
    pub commands: &'static [CommandInfo],
    pub subcommand_required: bool,
    pub visible_aliases: &'static [&'static str],
    pub aliases: &'static [&'static str],
    pub hidden: bool,
}

The description of a command: its name, texts, arguments and subcommands.

Values are built with CommandInfo::new and the const builder methods, so that fields can be added without breaking existing code.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: &'static str

The name of the command, as typed on the command line.

about: &'static str

The short description, from about or the first paragraph of the doc comment. Empty when not set.

long_about: &'static str

The long description, from long_about or the full doc comment. Empty when not set.

version: Option<&'static str>

The version set with #[command(version)].

args: &'static [ArgInfo]

The arguments, flattened structs included, in field order, followed by the generated --help and --version flags.

commands: &'static [CommandInfo]

The subcommands, from a #[command(subcommand)] field, in variant order. Their args do not repeat the global arguments of their parents.

subcommand_required: bool

Whether one of the commands must be given.

visible_aliases: &'static [&'static str]

The aliases of a subcommand listed in the help.

aliases: &'static [&'static str]

The aliases of a subcommand hidden from the help.

hidden: bool

Whether the subcommand is hidden from the help.

Implementations

impl CommandInfo

pub const fn new(name: &'static str) -> Self

A command named name, without description, version, arguments or subcommands.

pub const fn subcommand_required(self, required: bool) -> Self

Sets subcommand_required.

pub const fn visible_aliases(self, aliases: &'static [&'static str]) -> Self

Sets visible_aliases.

pub const fn aliases(self, aliases: &'static [&'static str]) -> Self

Sets aliases.

pub const fn hidden(self, hidden: bool) -> Self

Sets hidden.

pub const fn about(self, about: &'static str) -> Self

Sets about.

pub const fn long_about(self, long_about: &'static str) -> Self

Sets long_about.

pub const fn version(self, version: &'static str) -> Self

Sets version.

pub const fn args(self, args: &'static [ArgInfo]) -> Self

Sets args.

pub const fn commands(self, commands: &'static [CommandInfo]) -> Self

Sets commands.

Trait Implementations

impl Clone for CommandInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CommandInfo

impl Debug for CommandInfo

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

Formats the value using the given formatter.

impl Eq for CommandInfo

impl PartialEq for CommandInfo

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CommandInfo