Struct IndexDocument 

pub struct IndexDocument {
    pub title: String,
    pub nodes: Vec<IndexNode>,
    pub metadata: Metadata,
}

A semantic document emitted by the transformer and consumed by renderers.

Fields

title: String

Document title.

nodes: Vec<IndexNode>

Ordered semantic nodes.

metadata: Metadata

Optional page metadata.

Implementations

impl IndexDocument

pub fn titled(title: impl Into<String>) -> Self

Creates a document with a title.

pub fn push(&mut self, node: IndexNode)

Adds a node to the document.

pub fn is_empty(&self) -> bool

Returns true when the document has no user-visible nodes.

Trait Implementations

impl Clone for IndexDocument

fn clone(&self) -> IndexDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexDocument

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

Formats the value using the given formatter.

impl Default for IndexDocument

fn default() -> IndexDocument

Returns the “default value” for a type.

impl PartialEq for IndexDocument

fn eq(&self, other: &IndexDocument) -> 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 Eq for IndexDocument

impl StructuralPartialEq for IndexDocument