Struct MarkupDoc 

pub struct MarkupDoc {
    pub title: Option<String>,
    pub blocks: Vec<MarkupBlock>,
    pub attrs: BTreeMap<String, Expr>,
    pub source: Option<SourceDoc>,
}

A semantic markup document independent of its concrete source backend.

Fields

title: Option<String>

Optional document title.

blocks: Vec<MarkupBlock>

Semantic block sequence.

attrs: BTreeMap<String, Expr>

Open document attributes carried as ordinary SIM expressions.

source: Option<SourceDoc>

Original source text, when a backend can preserve it.

Implementations

impl MarkupDoc

pub fn as_expr(&self) -> Expr

Project this markup document into ordinary SIM data.

pub fn from_expr(expr: &Expr) -> Result<Self>

Reconstruct a markup document from ordinary SIM data.

pub fn to_source_text(&self) -> String

Render this document to a deterministic source string.

When verbatim source is present, it wins. Documents constructed directly from semantic blocks use a small Markdown-like writer.

Trait Implementations

impl Clone for MarkupDoc

fn clone(&self) -> MarkupDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkupDoc

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

Formats the value using the given formatter.

impl PartialEq for MarkupDoc

fn eq(&self, other: &MarkupDoc) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MarkupDoc