Struct Command 

pub struct Command {

    pub name: &'static str,
    pub about: &'static str,
    pub long_about: &'static str,
    pub after_help: &'static str,
    pub after_long_help: &'static str,
    pub items: &'static [Item],
    pub subcommands: &'static [Sub],
    pub subcommand_required: bool,
    pub help_flag: bool,
    pub help_short: bool,
    pub version: Option<&'static str>,
    pub default_subcommand: Option<&'static str>,
    pub default_subcommand_flags: bool,
    pub default_subcommand_help: bool,
    pub flatten_help: bool,
    pub examples: &'static [Example],
    pub headings: &'static [Heading],
}

One command’s help: what it is, what it takes, what it contains.

Written by the derive, as Item and Sub are. Fields are added as help learns to show more: a value written by hand ends in ..Command::EMPTY, and so keeps compiling when one is.

Fields

name: &'static str

The command’s own name; empty for a root that leaves it to argv[0].

about: &'static str

First paragraph of the description.

long_about: &'static str

The whole description, for --help.

after_help: &'static str

Text after the lists, for -h.

after_long_help: &'static str

Text after the lists, for --help.

items: &'static [Item]

Flags and positionals, in declaration order.

subcommands: &'static [Sub]

Subcommands, in declaration order.

subcommand_required: bool

Whether a subcommand must be given.

help_flag: bool

Whether --help is supplied (not declared or disabled).

help_short: bool

Whether the supplied help flag has -h as well as --help.

version: Option<&'static str>

The version, when -V/--version are supplied.

default_subcommand: Option<&'static str>

The subcommand a line that names none runs: marked (default) in the list.

default_subcommand_flags: bool

Whether a flag this command does not take selects the default subcommand too.

default_subcommand_help: bool

Whether the default subcommand’s page follows this one.

flatten_help: bool

Whether each subcommand’s usage line, description and arguments stand where the list of subcommands would.

examples: &'static [Example]

Command lines to try, in an Examples section.

headings: &'static [Heading]

What --help says under a heading, before its entries.

Implementations

impl Command

pub const EMPTY: Command

A command that takes nothing and says nothing. A value written by hand ends in ..Command::EMPTY, and a release that adds a field does not break it.

Trait Implementations

impl Debug for Command

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

Formats the value using the given formatter.