Struct HelpTopic 

pub struct HelpTopic {
    pub name: String,
    pub summary: String,
    pub body: HelpTopicBody,
    pub related_command_patterns: Vec<String>,
    pub plugin_id: Option<u64>,
}

One free-form help topic.

Fields

name: String

summary: String

body: HelpTopicBody

related_command_patterns: Vec<String>

Substring patterns matched against command names by :describe-command. When any pattern is a substring of the command name (case-sensitive), the describe view emits a “See also” link to this topic.

plugin_id: Option<u64>

CR.1: the host-issued plugin id that contributed this topic, None for builtins. Provenance IS the teardown token — unload is HelpTopicRegistry::unregister_plugin, so there is no per-load list to record and therefore none to forget.

Implementations

impl HelpTopic

pub fn builtin( name: impl Into<String>, summary: impl Into<String>, body: HelpTopicBody, ) -> HelpTopic

A builtin topic: no plugin provenance, no related-command patterns. The shape most callers want; the struct literal stays available for the two that need more.

Trait Implementations

impl Debug for HelpTopic

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

Formats the value using the given formatter.