Enum DocumentFrontmatter 

#[non_exhaustive]
pub enum DocumentFrontmatter {
    Absent,
    Mapping {
        value: Map<String, Value>,
        location: FrontmatterLocation,
        anchors: FrontmatterAnchors,
    },
    Invalid {
        location: FrontmatterLocation,
        message: String,
    },
}

Frontmatter extracted from the first lines of a Markdown document.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Absent

The document does not start with a YAML frontmatter delimiter.

Mapping

A YAML mapping converted to the JSON value domain used by JSON Schema.

Fields

value: Map<String, Value>

The frontmatter mapping in JSON Schema’s object domain.

location: FrontmatterLocation

Source location of the complete delimited block.

anchors: FrontmatterAnchors

Positions of the entries inside the block, keyed by JSON Pointer.

An entry whose spelling has no character of its own — a block scalar with no content line — is absent; callers then fall back to Self::Mapping::location.

Invalid

A delimited block exists but is not a valid JSON-compatible YAML mapping.

Fields

location: FrontmatterLocation

Source location of the opening delimiter through the closing delimiter or end of file.

message: String

Human-readable parse or conversion failure.

Trait Implementations

impl Clone for DocumentFrontmatter

fn clone(&self) -> DocumentFrontmatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentFrontmatter

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

Formats the value using the given formatter.

impl Eq for DocumentFrontmatter

impl PartialEq for DocumentFrontmatter

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocumentFrontmatter