Struct NodeSnapshot 

pub struct NodeSnapshot {

    pub name: String,
    pub aliases: Vec<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub usage: Vec<String>,
    pub positionals: Vec<PositionalSnapshot>,
    pub flags: Vec<FlagSnapshot>,
    pub examples: Vec<ExampleSnapshot>,
    pub group: Option<String>,
    pub deprecated: Option<String>,
    pub detected_framework: Option<String>,
    pub provenance: ProvenanceSnapshot,
    pub hidden: bool,
    pub children_filled: bool,
    pub heading_attested: bool,
    pub unparsed: Vec<String>,
    pub subcommands: Vec<NodeSnapshot>,
    pub confession: Option<ConfessionSnapshot>,
}

Snapshot form of CommandNode. See this module’s doc comment for the normalization rules; in short, Option/Vec fields are omitted when empty, provenance.confidence is rounded, and subcommands order is preserved exactly as CommandNode stored it.

Fields

name: String

The command’s own name, e.g. "rebase" (not the full path).

aliases: Vec<String>

Alternate names this command is also invoked as.

summary: Option<String>

A one-line hint.

description: Option<String>

Long-form prose.

usage: Vec<String>

Raw usage patterns, kept verbatim.

positionals: Vec<PositionalSnapshot>

Positional arguments.

flags: Vec<FlagSnapshot>

This node’s own flags.

examples: Vec<ExampleSnapshot>

Worked examples.

group: Option<String>

Display grouping from the source.

deprecated: Option<String>

The deprecation reason, when deprecated.

detected_framework: Option<String>

The framework Tier A′ identified for this node, if any.

provenance: ProvenanceSnapshot

Which source(s) contributed this node’s own fields.

hidden: bool

True if this command should be hidden from the tree by default.

children_filled: bool

True when this node’s subcommands list is known-complete.

heading_attested: bool

True when this node was recovered from a bare-word block under a recognized command heading (spec §7 Tier B rule 1) rather than conjured from layout alone.

unparsed: Vec<String>

The tool’s raw --help output, one line per entry, set only when no parse produced anything structurally plausible.

subcommands: Vec<NodeSnapshot>

Direct subcommands, in exactly the order CommandNode stored them — never reordered. See this module’s doc comment.

confession: Option<ConfessionSnapshot>

What this node’s own --help text said about being an incomplete document, if anything (spec §6 rule 2b). Omitted entirely for the overwhelmingly common case, no confession printed at all.

Trait Implementations

impl Clone for NodeSnapshot

fn clone(&self) -> NodeSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeSnapshot

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

Formats the value using the given formatter.

impl From<&CommandNode> for NodeSnapshot

fn from(n: &CommandNode) -> Self

Converts to this type from the input type.

impl PartialEq for NodeSnapshot

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for NodeSnapshot

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 NodeSnapshot