Struct gray_matter::Matter

pub struct Matter<T: Engine> {
    pub delimiter: String,
    pub excerpt_delimiter: Option<String>,
    /* private fields */
}

Coupled with an Engine of choice, Matter stores delimiter(s) and handles parsing.

Fields

delimiter: String

excerpt_delimiter: Option<String>

Implementations

impl<T: Engine> Matter<T>

pub fn new() -> Self

pub fn parse(&self, input: &str) -> ParsedEntity

Runs parsing on the input. Uses the engine contained in self to parse any front matter detected.

Examples

Basic usage:

let matter: Matter<YAML> = Matter::new();
let input = "---\ntitle: Home\n---\nOther stuff";
let parsed_entity = matter.parse(input);

assert_eq!(parsed_entity.content, "Other stuff");

pub fn parse_with_struct<D: DeserializeOwned>(
    &self,
    input: &str
) -> Option<ParsedEntityStruct<D>>

Wrapper around parse, that deserializes any front matter into a custom struct. Supplied as an ease-of-use function to prevent having to deserialize manually.

Returns None if no front matter is found, or if the front matter is not deserializable into the custom struct.

Examples

Basic usage:

#[derive(serde::Deserialize)]
struct Config {
    title: String,
}

let matter: Matter<YAML> = Matter::new();
let input = "---\ntitle: Home\n---\nOther stuff";
let parsed_entity =  matter.parse_with_struct::<Config>(input).unwrap();

assert_eq!(parsed_entity.data.title, "Home");

Trait Implementations

impl<T: Engine> Default for Matter<T>

fn default() -> Self

Returns the “default value” for a type.