Struct Frontmatter 

pub struct Frontmatter {
    pub type_: Option<String>,
    pub id: Option<String>,
    pub created: Option<DateTime<FixedOffset>>,
    pub updated: Option<DateTime<FixedOffset>>,
    pub summary: Option<String>,
    pub status: Option<String>,
    pub tags: Vec<String>,
    pub extra: BTreeMap<String, Value>,
}

The parsed YAML frontmatter of a db.md file.

The universal-contract fields are typed accessors; everything else lands in extra as ambient context (unknown-field passthrough) and is round-tripped verbatim. The atomic writer re-emits keys in canonical order: type, id, created, updated, summary first, then type-specific fields, then status / tags.

Fields

type_: Option<String>

type — required on content files; the primary query key.

id: Option<String>

id — optional; derived from the file path when absent.

created: Option<DateTime<FixedOffset>>

created — RFC3339; required and auto-set on content-file create.

updated: Option<DateTime<FixedOffset>>

updated — RFC3339; required and auto-maintained on content files.

summary: Option<String>

summary — the one-line catalog line; required on every content file.

status: Option<String>

status — optional lifecycle state.

tags: Vec<String>

tags — optional flat list of short scalar labels.

extra: BTreeMap<String, Value>

All other frontmatter keys (type-specific + custom), preserved verbatim in insertion-stable sorted order. Wiki-link-valued fields keep their raw YAML form here; Frontmatter::link_fields surfaces them as WikiLinks.

Implementations

impl Frontmatter

pub fn parse(yaml: &str, file: &Path) -> Result<Self, ParseError>

Parse a YAML frontmatter block (the text between the opening and closing --- fences, exclusive) into a Frontmatter.

Lenient on unknown keys (they go to extra); returns ParseError::MalformedYaml only on YAML that doesn’t parse.

pub fn to_yaml(&self) -> String

Serialize the frontmatter back to a YAML block (no --- fences) in canonical key order. Round-trips extra verbatim.

pub fn is_content_file(path: &Path) -> bool

True if the file is content (under sources/, records/, or wiki/) and not an index.md. Used by validate to decide which files require a summary. Meta files (DB.md, index.md, log.md) return false.

pub fn effective_id(&self, store_relative_path: &Path) -> String

Resolve the file’s effective id: the explicit id field if present, otherwise derived from the store-relative path (filename without .md).

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

Read a single frontmatter key as a raw YAML Value, looking in the typed fields first and then extra.

pub fn set(&mut self, key: &str, value: &str) -> Result<(), ParseError>

Set a single frontmatter key from a string value, routing universal- contract keys to their typed fields and everything else to extra. Used by dbmd fm set.

pub fn link_fields(&self) -> Vec<(String, WikiLink)>

Extract every frontmatter field whose value is a wiki-link (scalar inline form or a block-sequence list), pairing each with its key. The validate engine checks these against (link) schema annotations.

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.

impl PartialEq for Frontmatter

fn eq(&self, other: &Frontmatter) -> 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 Frontmatter