Struct FootnoteRenderParams 

pub struct FootnoteRenderParams<'a> {
    pub index: Option<&'a str>,
    pub id: Option<&'a str>,
    pub is_reference: bool,
    pub text: &'a str,
}

Provides parameters for rendering the inline marker of a footnote macro.

There are three cases the renderer must distinguish:

• A defining occurrence (index is Some, is_reference is false): the footnote introduces new text. The marker carries the footnote number and, when the footnote was given an ID, an id of its own.
• A reference to an earlier footnote (index is Some, is_reference is true): a later occurrence (footnote:id[]) that reuses an existing footnote’s number.
• An unresolved reference (index is None, is_reference is true): a reference whose ID was never defined; the renderer emits a visible error marker built from text.

Fields

index: Option<&'a str>

The footnote’s number, or None for an unresolved reference. Normally a consecutive integer, but the footnote-number counter honors any seed the document sets, so it is passed through as text.

id: Option<&'a str>

The footnote’s own ID, used only on a defining occurrence to produce the id="_footnote_<id>" attribute on the marker.

is_reference: bool

true when this occurrence references an existing footnote (or fails to resolve one); false for the defining occurrence.

text: &'a str

For an unresolved reference, the text to show inside the error marker (the unresolved ID). Ignored in the other cases.

Trait Implementations

impl<'a> Clone for FootnoteRenderParams<'a>

fn clone(&self) -> FootnoteRenderParams<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for FootnoteRenderParams<'a>

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

Formats the value using the given formatter.