Struct HelpDoc 

pub struct HelpDoc {
    pub feature: &'static str,
    pub group: &'static str,
    pub synopsis: &'static str,
    pub syntax: &'static str,
    pub params: &'static [HelpParam],
    pub examples: &'static [&'static str],
    pub gotchas: &'static [&'static str],
    pub related: &'static [&'static str],
}

One feature’s compiled documentation. feature matches the tool/CLI name so lookups are stable.

Fields

feature: &'static str

group: &'static str

synopsis: &'static str

syntax: &'static str

params: &'static [HelpParam]

examples: &'static [&'static str]

gotchas: &'static [&'static str]

related: &'static [&'static str]

Trait Implementations

impl Clone for HelpDoc

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpDoc

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

Formats the value using the given formatter.

impl Serialize for HelpDoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.