Struct HelpTopicSpec 

pub struct HelpTopicSpec {
    pub name: String,
    pub summary: String,
    pub body: String,
    pub related_command_patterns: Vec<String>,
}

One topic a guest declared, ready for the loader to register.

Plain data — deliberately not a lattice_help::HelpTopic, see the module docs. name is already namespaced.

Fields

name: String

The registered (namespaced) topic name — what :help <name> opens.

summary: String

body: String

Markdown, as the guest baked it into its component.

related_command_patterns: Vec<String>

Substring patterns :describe-command matches against command names to emit a See also cross-link.

Trait Implementations

impl Clone for HelpTopicSpec

fn clone(&self) -> HelpTopicSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpTopicSpec

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

Formats the value using the given formatter.

impl Eq for HelpTopicSpec

impl PartialEq for HelpTopicSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HelpTopicSpec