Struct FootnoteIndex 

pub struct FootnoteIndex { /* private fields */ }

The document’s footnotes, numbered.

Numbering is first-reference order — the order a reader meets the markers, not the order the author wrote the definitions. It is derived state, deliberately not stored on the AST (same rule as super::node::ColumnAlignment’s numeric auto-alignment): the same Block::FootnoteDefinition renders differently depending on which document it is part of, so the number cannot belong to the node.

Scope: the whole block tree EXCEPT shortcode bodies. A :::grid cell or :::hero overlay is parsed and rendered as its own little document through super::render::render_blocks, which carries no index — see ADR-035 for why the three call paths differ.

Implementations

impl FootnoteIndex

pub fn build(blocks: &[Block]) -> Self

Build the index for a block tree. Empty when the tree defines no footnotes, which is the overwhelmingly common case.

pub fn is_empty(&self) -> bool

True when the document has no footnotes to render.

pub fn number(&self, label: &str) -> Option<usize>

The printed number for label, or None when no definition in this index owns it.

pub fn entries(&self) -> &[(usize, String)]

(number, label) pairs in endnote order.

pub fn definition<'a>(blocks: &'a [Block], label: &str) -> Option<&'a [Block]>

The body blocks of the FIRST definition of label in document order, at any depth. A repeated label is an authoring error; first wins.

Trait Implementations

impl Clone for FootnoteIndex

fn clone(&self) -> FootnoteIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FootnoteIndex

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

Formats the value using the given formatter.

impl Default for FootnoteIndex

fn default() -> FootnoteIndex

Returns the “default value” for a type.

impl Eq for FootnoteIndex

impl PartialEq for FootnoteIndex

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FootnoteIndex