Struct OkfDocument 

pub struct OkfDocument {
    pub front: Yaml,
    pub sections: BTreeMap<String, String>,
    pub section_order: Vec<String>,
}

A parsed OKF file.

Fields

front: Yaml

Machine-readable front matter.

sections: BTreeMap<String, String>

Body sections, keyed by their # heading text.

section_order: Vec<String>

Heading order as it appeared, so emitting is stable.

Implementations

impl OkfDocument

pub fn new(front: Yaml, sections: Vec<(&str, String)>) -> Self

Build a document from front matter and ordered sections.

pub fn section(&self, heading: &str) -> Option<&str>

Read a section body by heading.

pub fn section_list(&self, heading: &str) -> Vec<String>

Read a section as a - item list.

pub fn parse(source: &str, path: &str) -> Result<Self, MemoryError>

Parse an OKF file.

pub fn parse_many(source: &str, path: &str) -> Result<Vec<Self>, MemoryError>

Parse a category file holding several records back to back.

Records are delimited by --- fences in pairs: open, front matter, close, body, then the next record’s open fence. A body line that is exactly --- would therefore be read as a record boundary, so Self::render_many refuses to write one.

pub fn render_many(docs: &[Self], path: &str) -> Result<String, MemoryError>

Render several records into one category file.

pub fn to_markdown(&self) -> String

Render the document back to text.

Trait Implementations

impl Clone for OkfDocument

fn clone(&self) -> OkfDocument

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OkfDocument

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

Formats the value using the given formatter.

impl PartialEq for OkfDocument

fn eq(&self, other: &OkfDocument) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OkfDocument