Struct DocValue 

pub struct DocValue {
    pub text: String,
    pub format: DocFormat,
    pub blocks: Vec<DocBlock>,
}

A decoded document: its full source text, detected format, and the ordered DocBlocks parsed from it.

Block offsets index into text, so the document carries provenance for every span it exposes and round-trips back to the original source.

Fields

text: String

The complete, unmodified source text of the document.

format: DocFormat

The detected source format (DocFormat::Markdown when any heading was seen, otherwise DocFormat::Text).

blocks: Vec<DocBlock>

The ordered blocks parsed from text.

Implementations

impl DocValue

pub fn as_expr(&self) -> Expr

Project this document into its Expr map form (kind: doc, with format, text, and a list of block maps).

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

Reconstruct a DocValue from an Expr, accepting a raw string, a compatibility kind: doc map, or the shared kind: markup-doc map. Fails closed on any other expression shape.

Trait Implementations

impl Clone for DocValue

fn clone(&self) -> DocValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocValue

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

Formats the value using the given formatter.

impl Eq for DocValue

impl PartialEq for DocValue

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocValue