Struct HelpPage 

pub struct HelpPage {
    pub app_name: String,
    pub version: Option<String>,
    pub path: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub usage: String,
    pub positionals: Vec<HelpArg>,
    pub options: Vec<HelpOption>,
    pub subcommands: Vec<HelpSubcommand>,
    pub examples: Vec<String>,
    pub notes: Vec<String>,
}

everything we need to print help for a command path.

Fields

app_name: String

Name of the binary / application (e.g. “git”)

version: Option<String>

Application version (from clap metadata).

path: String

Full command path (e.g. “commit main”)

summary: Option<String>

One-line summary (from clap)

description: Option<String>

Optional longer description

usage: String

Usage string (from clap)

positionals: Vec<HelpArg>

Positional arguments

options: Vec<HelpOption>

Flags and options

subcommands: Vec<HelpSubcommand>

Subcommands (for category-level help)

examples: Vec<String>

Examples

notes: Vec<String>

Notes / tips / caveats

Implementations

impl HelpPage

pub fn from_clap( app_name: &str, version: Option<&str>, path: &str, cmd: &Command, ) -> Self

build a page straight from a clap::Command.

pub fn with_docs(self, doc: Option<&CommandDoc>) -> Self

merge data from a CommandDoc, falling back to clap metadata when missing.

Trait Implementations

impl Clone for HelpPage

fn clone(&self) -> HelpPage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpPage

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

Formats the value using the given formatter.