Struct Footnote 

pub struct Footnote {
    pub index: String,
    pub id: Option<String>,
    pub text: String,
    /* private fields */
}

A footnote registered while substituting the inline footnote:[…] macro.

A footnote is defined at the location of its reference, but its text is extracted to an item in the document’s footnote list. The same footnote can be referenced from multiple locations by assigning it an ID at the first occurrence and repeating that ID (with empty text) afterward; only the defining occurrence produces a Footnote entry.

Fields

index: String

The footnote’s number, assigned in document order via the footnote-number counter. Normally a consecutive integer (1, 2, …), but stored as a string because the counter honors any seed the document sets (e.g. :footnote-number: z yields aa, ab, … as Asciidoctor does).

id: Option<String>

The optional ID assigned to this footnote (the target of the macro, e.g. disclaimer in footnote:disclaimer[…]). None for an anonymous footnote.

text: String

The already-substituted text of the footnote. When the footnote contains cross-references, this reflects the unresolved fallback rendering until the document’s references are resolved, after which it reflects the resolved links; it is always clean, user-facing text.

Trait Implementations

impl Clone for Footnote

fn clone(&self) -> Footnote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Footnote

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

Formats the value using the given formatter.

impl Eq for Footnote

impl PartialEq for Footnote

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Footnote