Struct Frontmatter 

pub struct Frontmatter {
    pub raw_yaml: String,
    pub byte_range: Range<usize>,
    /* private fields */
}

Parsed YAML frontmatter from a markdown file. Schema-free.

Fields

raw_yaml: String

Raw YAML text between the --- delimiters (excluding delimiters).

byte_range: Range<usize>

Byte range of the entire frontmatter block including --- delimiters.

Implementations

impl Frontmatter

pub fn get(&self, field: &str) -> Option<&Value>

Get a frontmatter field by name.

pub fn has_field(&self, field: &str) -> bool

Check if a field exists in the frontmatter.

pub fn get_str(&self, field: &str) -> Option<&str>

Get a field as a string, if it is one.

pub fn get_str_list(&self, field: &str) -> Vec<&str>

Get a field as a string list (handles both YAML sequences and single strings).

pub fn data(&self) -> &Value

Get the full parsed data.

Trait Implementations

impl Clone for Frontmatter

fn clone(&self) -> Frontmatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frontmatter

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

Formats the value using the given formatter.