Struct CliDoc 

pub struct CliDoc {
    pub command: String,
    pub usage: String,
    pub description: String,
    pub flags: Vec<CliFlagDoc>,
}

Serializable documentation for an action’s CLI surface.

Fields

command: String

Subcommand name.

usage: String

Usage string shown in help.

description: String

Human-readable description of the subcommand.

flags: Vec<CliFlagDoc>

Flags accepted by the subcommand.

Trait Implementations

impl Clone for CliDoc

fn clone(&self) -> CliDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CliDoc

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

Formats the value using the given formatter.

impl PartialEq for CliDoc

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CliDoc

impl StructuralPartialEq for CliDoc