Skip to main content

Module frontmatter

Module frontmatter 

Source
Expand description

Reading the metadata block of a source document.

A thin reading layer over prov::Document: rendering only ever reads frontmatter, so the write half — serialize, set or remove a property, splice a body — has no counterpart here. A caller that needs it has prov’s editor.

Structs§

ParsedFile
A document split into its metadata mapping and its body.

Functions§

get_string
A string-valued property, when present and actually a string.
get_string_array
A sequence-valued property, as its string elements. Empty when the key is absent, is not a sequence, or holds no strings.
parse_or_empty
Parse a document, treating “no metadata block” as an empty one.