Struct CliDocument 

pub struct CliDocument {
    pub schema: &'static str,
    pub version: String,
    pub source: &'static str,
    pub route_prefix: &'static str,
    pub cli: CommandDoc,
}

The machine-readable projection of the whole tree: docs/generated/cli.json, the file the website’s generator reads. One document, deterministic, with no provenance of its own beyond the crate version.

Fields

schema: &'static str

SCHEMA.

version: String

The crate version that wrote it.

source: &'static str

DECLARATION: the file every command in this document is declared in.

route_prefix: &'static str

The route prefix the command routes are under.

cli: CommandDoc

The command tree, root first.

Trait Implementations

impl Clone for CliDocument

fn clone(&self) -> CliDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CliDocument

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

Formats the value using the given formatter.

impl Eq for CliDocument

impl PartialEq for CliDocument

fn eq(&self, other: &CliDocument) -> 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 CliDocument

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 CliDocument