Struct HelpContent 

pub struct HelpContent {
    pub buffer: HelpBuffer,
    pub metadata: HelpMetadata,
}

M.3.2.c.5: pair of (slim help buffer, parsed metadata) returned from every help factory. The App splits this into:

• buffer -> App.popup_buffer (the popup hot-path slot)
• metadata -> App.buffer_locals[buffer.id] via seed_help_metadata_locals at popup-open time.

Fields

buffer: HelpBuffer

metadata: HelpMetadata

Implementations

impl HelpContent

pub fn scroll_to_anchor(&mut self, name: &str) -> bool

Scroll to a named anchor in the metadata. Returns true if the anchor was found and the buffer’s scroll advanced. Reads metadata.anchors (the canonical owner of help per-buffer state per M.3.2.c.5); production code paths scroll through this method or, when working from a registry slot, by looking up HelpAnchors in buffer_locals.

impl HelpContent

pub fn from_lines(title: impl Into<String>, lines: Vec<String>) -> Self

Build a help buffer from a list of pre-formatted lines. Lines may contain [label](scheme:value) markdown links – the parser indexes them into the returned metadata’s links vec at the label’s byte range in the joined output. No syntax highlighting is attached – help buffers receive their syntax and link styling from the live cells-worker DisplayMatrix (link spans seeded via link_highlights into the buffer’s ExtraHighlights local).

pub fn from_lines_and_anchors( title: impl Into<String>, lines: Vec<String>, anchors: Vec<HelpAnchor>, ) -> Self

Build with explicit anchors. Used by the introspection renderer to feed RenderedIntrospection.anchors through.

Methods from Deref<Target = HelpBuffer>

pub fn line_count(&self) -> u32

Number of visible content lines (the popup renderer uses this to clamp scroll). CV.3: content space, as the name already promised — it was reading ropey’s raw count, which let the scroll clamp reach one row past the last help line.

pub fn lines(&self) -> Vec<String>

Iterate the rendered lines top-down. Allocates – Buffer doesn’t expose per-line slicing yet. Acceptable for v1; the popup renderer only calls this on a small visible window.

Trait Implementations

impl Clone for HelpContent

fn clone(&self) -> HelpContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpContent

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

Formats the value using the given formatter.

impl Deref for HelpContent

type Target = HelpBuffer

The resulting type after dereferencing.

fn deref(&self) -> &HelpBuffer

Dereferences the value.

impl DerefMut for HelpContent

fn deref_mut(&mut self) -> &mut HelpBuffer

Mutably dereferences the value.