Struct HelpTopicRegistry 

pub struct HelpTopicRegistry { /* private fields */ }

Catalogue of every registered topic, keyed by name. Plugins and future LSP integrations register through register.

Topics are held behind Arc so the registry is cheap to Clone, which is what the HelpTopicRegistryHandle RCU write path needs (clone → mutate → store). The Arc earns its place beyond clone cost: HelpTopicBody::Compressed carries a OnceLock decompression cache, and sharing the topic means an RCU write does not throw away every already-inflated body.

Implementations

impl HelpTopicRegistry

pub fn new() -> Self

pub fn into_handle(self) -> HelpTopicRegistryHandle

Wrap this registry in a fresh HelpTopicRegistryHandle.

Exists so consumers — the host’s boot, the loader’s drain, their tests — do not each have to name arc_swap just to build the handle this crate defines.

pub fn register(&mut self, topic: HelpTopic)

pub fn unregister_plugin(&mut self, plugin_id: u64) -> usize

Drop every topic contributed by plugin_id, returning how many were removed. Idempotent: a second call reports zero, which is what the teardown contract requires of a double-unload.

Builtins carry plugin_id: None and are therefore untouchable through this path — no plugin’s unload can remove a core page.

pub fn lookup(&self, name: &str) -> Option<&HelpTopic>

pub fn names(&self) -> impl Iterator<Item = &str>

pub fn iter(&self) -> impl Iterator<Item = &HelpTopic>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn topics_for_command<'a>( &'a self, command_name: &'a str, ) -> impl Iterator<Item = &'a HelpTopic> + 'a

Find every topic whose related_command_patterns contains a substring of command_name. Used by :describe-command to emit cross-links. Stable insertion order; multiple topics can match.

Trait Implementations

impl Clone for HelpTopicRegistry

fn clone(&self) -> HelpTopicRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpTopicRegistry

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

Formats the value using the given formatter.

impl Default for HelpTopicRegistry

fn default() -> HelpTopicRegistry

Returns the “default value” for a type.