Struct ParsedDocument 

pub struct ParsedDocument {
    pub frontmatter: HashMap<String, Value>,
    pub body: String,
    pub frontmatter_range: Option<(usize, usize)>,
    pub frontmatter_error: Option<String>,
}

A parsed markdown document with frontmatter separated from body.

Fields

frontmatter: HashMap<String, Value>

Parsed frontmatter key-value pairs.

body: String

The markdown body (everything after the closing ---).

frontmatter_range: Option<(usize, usize)>

Byte offsets of the frontmatter block: (start_of_opening_delimiter, end_of_closing_delimiter). None if no frontmatter was found.

frontmatter_error: Option<String>

serde_yaml error message when a delimited ---...--- block failed to parse as YAML. None when the block parsed cleanly or there was no delimited block. When Some, frontmatter is empty and body still holds the WHOLE document (so the editor can show/repair the bad block); use render_body() for the HTML-render view that excludes it.

#[serde(default)] is defensive: the type derives Deserialize but is transient (no code deserializes INTO it).

Implementations

impl ParsedDocument

pub fn render_body(&self) -> &str

Body suitable for RENDERING to HTML (build pipeline): excludes a delimited frontmatter block that FAILED to parse, so malformed YAML never leaks verbatim into output. Equal to body when the frontmatter parsed cleanly or there was no block.

The EDITOR must NOT use this — it needs the raw body so the author can see/repair the bad block and a full-reserialize save preserves it.

Trait Implementations

impl Clone for ParsedDocument

fn clone(&self) -> ParsedDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParsedDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParsedDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ParsedDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.