Struct Frontmatter 

pub struct Frontmatter {
    pub map: Mapping,
}

Parsed frontmatter, retaining the full YAML mapping so verify can inspect wrong-typed values (rather than failing to parse them).

Fields

map: Mapping

Implementations

impl Frontmatter

pub fn new() -> Self

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

pub fn contains_key(&self, key: &str) -> bool

pub fn keys(&self) -> impl Iterator<Item = &str>

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

String value of key, only if it is actually a YAML string.

pub fn id(&self) -> Option<&str>

pub fn status(&self) -> Option<&str>

pub fn tags(&self) -> Option<Vec<String>>

tags as a list of strings, when it is a sequence whose elements are all strings. Returns None if absent or wrong-shaped (verify reports).

pub fn tags_is_nonempty_list(&self) -> bool

True when tags is present and is a non-empty sequence.

pub fn has_tag(&self, query: &str) -> bool

True when the document carries query as a tag — either an exact tag, or any tag whose key (the head before : or =) equals query. So area matches area, area:parsing, and area=high.

pub fn set_str(&mut self, key: &str, value: impl Into<String>)

pub fn set_tags(&mut self, tags: &[String])

pub fn insert(&mut self, key: &str, value: Value)

pub fn remove(&mut self, key: &str) -> Option<Value>

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.

impl Default for Frontmatter

fn default() -> Frontmatter

Returns the “default value” for a type.