Struct CommandDoc 

pub struct CommandDoc {
    pub path: Vec<String>,
    pub route: String,
    pub executable: bool,
    pub usage: String,
    pub about: String,
    pub long_about: Option<String>,
    pub args: Vec<ArgDoc>,
    pub examples: Vec<ExampleView>,
    pub aliases: Vec<String>,
    pub subcommands: Vec<CommandDoc>,
}

One command of the executable’s command line, as clap declares it, with the commands under it. The root is majordomus.

Fields

path: Vec<String>

The full path, ["majordomus", "bench", "coverage"].

route: String

The route of this command’s page, /docs/cli/bench/coverage/. Derived here once so that no consumer downstream repeats the rule.

executable: bool

Whether the command can be run on its own: a leaf, or a parent that does something when no subcommand follows it. A command that only groups others cannot be run and carries no example.

usage: String

The usage line, majordomus bench coverage [OPTIONS], derived here so that no projection assembles one of its own.

about: String

The one-line description.

long_about: Option<String>

The long description, when the command has one.

args: Vec<ArgDoc>

The arguments in declaration order: positionals and options, --help and --version excluded.

examples: Vec<ExampleView>

The documented examples of this command, in declaration order. Every one of them is parsed by this crate’s own parser and run against the built executable by the example tests; nothing is shown that is not run.

aliases: Vec<String>

The other names this command answers to, ["wt"], as clap declares them.

An alias is declared once, on the command, and every projection that has a use for one — the completion, the generated workflow bridge, the reference page — reads it here rather than keeping a table of its own.

subcommands: Vec<CommandDoc>

The subcommands in declaration order.

Implementations

impl CommandDoc

pub fn flatten(&self) -> Vec<&CommandDoc>

Every command, this one first, then the subcommands depth first.

pub fn command(&self) -> String

The command as a person types it: majordomus bench coverage.

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

The route of the command this one is under, or None for the root.

Trait Implementations

impl Clone for CommandDoc

fn clone(&self) -> CommandDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandDoc

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

Formats the value using the given formatter.

impl Eq for CommandDoc

impl PartialEq for CommandDoc

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CommandDoc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandDoc