Struct HelpTopicsGenerator 

pub struct HelpTopicsGenerator {
    pub topics: Arc<ArcSwapAny<Arc<HelpTopicRegistry>>>,
}

gen:help-topics. Returns one RawCandidate per registered help topic so :help <Tab> enumerates available topics. The payload is CandidateData::Plain – topic name alone is enough for the v1 popup; future polish can introduce a richer HelpTopic variant if summaries need to flow through the matcher / annotator pipeline.

CR.1: holds the handle, not a snapshot. A snapshot taken at boot would enumerate the builtin set forever, so a plugin’s pages would exist and open by name but never appear in :help <Tab> — the same gap one level down, and a quieter one.

Fields

topics: Arc<ArcSwapAny<Arc<HelpTopicRegistry>>>

Trait Implementations

impl CandidateGenerator for HelpTopicsGenerator

fn generate(&self, _ctx: &GenerateContext<'_>) -> Vec<RawCandidate>

fn cache_key(&self, _ctx: &GenerateContext<'_>) -> Option<CacheKey>

Optional cache key. When two contexts produce the same Some(key), the pipeline serves the second from cache. The query (prefix) is implicitly part of the key only if the generator includes it – many generators key on a registry version (cache covers all queries until the registry changes) and let the matcher do the per-query filtering.

fn cache_ttl(&self) -> Duration

Soft TTL for cache entries. After elapsing, the entry is regenerated on next access. Defaults to no expiry.