Struct Frontmatter 

pub struct Frontmatter<'a> {
    pub title: Option<String>,
    pub description: Option<String>,
    pub order: Option<i64>,
    pub tags: Vec<String>,
    pub body: &'a str,
}

The frontmatter fields this library reads, and the text after it.

Fields

title: Option<String>

description: Option<String>

order: Option<i64>

tags: Vec<String>

body: &'a str

Implementations

impl<'a> Frontmatter<'a>

pub fn parse(text: &'a str) -> Self

Read a leading --- … --- block of key: value lines (values may be quoted; tags is [a, b] or a, b). Text without one is all body.

Trait Implementations

impl<'a> Debug for Frontmatter<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Frontmatter<'a>

fn default() -> Self

Returns the “default value” for a type.