Struct ftml::parsing::UnstructuredParseResult

pub struct UnstructuredParseResult<'r, 't> {
    pub result: ParseResult<'r, 't, Vec<Element<'t>>>,
    pub table_of_contents_depths: Vec<(usize, String)>,
    pub footnotes: Vec<Vec<Element<'t>>>,
    pub has_footnote_block: bool,
    pub bibliographies: BibliographyList<'t>,
}

Fields

result: ParseResult<'r, 't, Vec<Element<'t>>>

The returned result from parsing.

table_of_contents_depths: Vec<(usize, String)>

The “depths” list for table of content entries.

Each value is a zero-indexed depth of how

footnotes: Vec<Vec<Element<'t>>>

The list of footnotes.

Each entry is a series of elements, in combination they make the contents of one footnote.

has_footnote_block: bool

Whether a footnote block was placed during parsing.

bibliographies: BibliographyList<'t>

The list of bibliographies.

See src/tree/bibliography.rs.

Trait Implementations

impl<'r, 't> Clone for UnstructuredParseResult<'r, 't>

fn clone(&self) -> UnstructuredParseResult<'r, 't>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'r, 't> Debug for UnstructuredParseResult<'r, 't>

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

Formats the value using the given formatter.

impl<'de, 'r, 't> Deserialize<'de> for UnstructuredParseResult<'r, 't>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'r, 't> Serialize for UnstructuredParseResult<'r, 't>

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

Serialize this value into the given Serde serializer.