Struct Footnote 

pub struct Footnote {
    pub number: u32,
    pub id: Option<String>,
    pub content: Option<String>,
    pub children: Vec<Block>,
}

A footnote with content blocks.

Per the spec, footnotes support either content (plain text) or children (rich content with blocks), but not both on the same footnote.

Fields

number: u32

Sequential footnote number.

id: Option<String>

Optional unique identifier for cross-referencing with footnote marks.

content: Option<String>

Simple text content (for footnotes without complex formatting). Mutually exclusive with children.

children: Vec<Block>

Rich content blocks (paragraph blocks with formatting). Mutually exclusive with content.

Implementations

impl Footnote

pub fn new(number: u32) -> Self

Create a new footnote with the given number.

pub fn with_id(self, id: impl Into<String>) -> Self

Set the unique identifier.

pub fn with_content(self, content: impl Into<String>) -> Self

Set the text content (simple footnotes without formatting).

Note: This is mutually exclusive with with_children. If both are set, implementations should prefer children.

pub fn with_children(self, children: Vec<Block>) -> Self

Set the rich content blocks (footnotes with formatting).

Note: This is mutually exclusive with with_content. If both are set, implementations should prefer children.

pub fn has_children(&self) -> bool

Check if this footnote has rich content (children).

pub fn has_content(&self) -> bool

Check if this footnote has simple content.

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<'de> Deserialize<'de> for Footnote

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for Footnote

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Footnote