Struct Document 

pub struct Document {
    pub meta: NodeMeta,
    pub children: Vec<Block>,
}

The root of a parsed document: a sequence of top-level Blocks.

Fields

meta: NodeMeta

Node metadata (source span).

children: Vec<Block>

The document’s top-level blocks, in source order.

Implementations

impl Document

pub fn to_html(&self) -> Result<String, HtmlError>

Render this document to safe-by-default HTML with default options.

pub fn to_html_with(&self, options: &HtmlOptions) -> Result<String, HtmlError>

Render this document to HTML with explicit options.

impl Document

pub fn to_markdown(&self) -> Result<String, SerializeError>

Serialize this document to canonical Markdown with default options.

pub fn to_markdown_with( &self, options: &SerializeOptions, ) -> Result<String, SerializeError>

Serialize this document to canonical Markdown with explicit options.

impl Document

pub fn validate(&self) -> Vec<Diagnostic>

Validate this document’s AST shape, returning a diagnostic for each invalid or unsupported node (empty when the document is well-formed).

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl Eq for Document

impl PartialEq for Document

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