Struct Frontmatter 

pub struct Frontmatter {
    pub type_: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub resource: Option<String>,
    pub tags: Vec<String>,
    pub status: Option<String>,
    pub origin: Option<Origin>,
    pub sources: Vec<String>,
}

A concept document’s frontmatter.

Only Self::type_ is required by the specification; every other field is omitted entirely when absent rather than written empty, because §11 tells consumers not to reject a document for a missing optional field and an empty string is a different claim from silence.

Fields

type_: String

type — the one required key. Named with a trailing underscore because type is a Rust keyword; it is written as type.

title: Option<String>

title — human-readable display name.

description: Option<String>

description — a single-sentence summary.

resource: Option<String>

resource — canonical URI for the underlying asset.

tags: Vec<String>

tags — categorisation strings.

status: Option<String>

status — draft | stable | deprecated.

origin: Option<Origin>

The origin, split into generated and verified on render.

sources: Vec<String>

sources — where the concept derives from, each with a resource.

Implementations

impl Frontmatter

pub fn render(&self) -> String

Render the frontmatter block, --- fences included.

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 Eq for Frontmatter

impl PartialEq for Frontmatter

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frontmatter