Module
marksy/frontmatter
src/marksy/frontmatter.pookaOpen the envelope before reading the letter. Only a --- line at the
very start opens TOML front matter; a rule later in the document belongs
to Markdown. The body keeps its original bytes and its source address.
let assert Ok(page) = frontmatter.read("---\ntitle = \"Owl\"\n---\n# Hello\n")
assert page.body == "# Hello\n"
assert page.body_line == 4
API reference
class Page(
metadata: Option(tome.Toml),
body: String,
body_line: Int,
body_byte_offset: Int
)
The body has not been parsed or normalised. Its byte offset starts at zero, while its line number starts at one, just like an editor's gutter.
metadata: Option(tome.Toml)
INFERRED
Option($package/tome/tome.Toml)body: String
INFERRED
Stringbody_line: Int
INFERRED
Intbody_byte_offset: Int
INFERRED
Int
INFERRED
fn(Option($package/tome/tome.Toml), String, Int, Int) -> marksy/frontmatter.Pageclass FrontmatterError(line: Int, message: String)
Error lines refer to the complete input, including the opening delimiter.
line: Int
INFERRED
Intmessage: String
INFERRED
String
INFERRED
fn(Int, String) -> marksy/frontmatter.FrontmatterErrorread(source: String) -> Result(Page, FrontmatterError)
INFERRED
fn(String) -> Result(marksy/frontmatter.Page, marksy/frontmatter.FrontmatterError)Read optional TOML between exact --- lines. An opening delimiter commits
to front matter: missing closing delimiters and invalid TOML are errors.
let assert Ok(page) = frontmatter.read("# A page without an envelope\n")
assert page.metadata == None