Struct SyntaxTree 

pub struct SyntaxTree<'t> {
    pub elements: Vec<Element<'t>>,
    pub table_of_contents: Vec<Element<'t>>,
    pub html_blocks: Vec<Cow<'t, str>>,
    pub code_blocks: Vec<CodeBlock<'t>>,
    pub footnotes: Vec<Vec<Element<'t>>>,
    pub needs_footnote_block: bool,
    pub bibliographies: BibliographyList<'t>,
    pub wikitext_len: usize,
}

Fields

elements: Vec<Element<'t>>

The list of elements that compose this tree.

Note that each Element<'t> can contain other elements within it, and these as well, etc. This structure composes the depth of the syntax tree.

table_of_contents: Vec<Element<'t>>

The full table of contents for this page.

Depth list conversion happens here, so that depths on the table match the heading level.

html_blocks: Vec<Cow<'t, str>>

The full list of HTML blocks for this page.

code_blocks: Vec<CodeBlock<'t>>

The full list of code blocks for this page.

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

The full footnote list for this page.

needs_footnote_block: bool

Whether the renderer should add its own footnote block.

This is true if there is no footnote block in the element list above, and there are footnotes to render.

bibliographies: BibliographyList<'t>

The full list of bibliographies for this page.

wikitext_len: usize

Hint for the size of the wikitext input.

This is an optimization to make rendering large parges slightly faster.

Implementations

impl<'t> SyntaxTree<'t>

pub fn to_owned(&self) -> SyntaxTree<'static>

Trait Implementations

impl<'t> Clone for SyntaxTree<'t>

fn clone(&self) -> SyntaxTree<'t>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'t> Debug for SyntaxTree<'t>

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

Formats the value using the given formatter.

impl<'t> Default for SyntaxTree<'t>

fn default() -> SyntaxTree<'t>

Returns the “default value” for a type.

impl<'de, 't> Deserialize<'de> for SyntaxTree<'t>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'t> PartialEq for SyntaxTree<'t>

fn eq(&self, other: &SyntaxTree<'t>) -> 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<'t> Serialize for SyntaxTree<'t>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'t> Eq for SyntaxTree<'t>

impl<'t> StructuralPartialEq for SyntaxTree<'t>