Enum FrontmatterPolicy 

#[non_exhaustive]
pub enum FrontmatterPolicy {
    Optional {
        schema: Option<FrontmatterSchema>,
    },
    Required {
        schema: Option<FrontmatterSchema>,
    },
    Forbidden {
        schema: Option<FrontmatterSchema>,
    },
}

The document’s normalized frontmatter policy.

This representation makes the invalid required: true, allow: false combination unrepresentable while retaining a schema declared alongside allow: false; if forbidden frontmatter is nevertheless present, the validation algorithm still evaluates that schema.

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.

Optional

Frontmatter may be absent; validate it against schema when present.

Fields

schema: Option<FrontmatterSchema>

JSON Schema to apply when frontmatter is present.

Required

Frontmatter must be present and is validated against schema.

Fields

schema: Option<FrontmatterSchema>

JSON Schema to apply to the required frontmatter mapping.

Forbidden

Frontmatter must not be present; validate it against schema if it is nevertheless present.

Fields

schema: Option<FrontmatterSchema>

JSON Schema to apply if forbidden frontmatter is present.

Trait Implementations

impl Clone for FrontmatterPolicy

fn clone(&self) -> FrontmatterPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrontmatterPolicy

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

Formats the value using the given formatter.

impl Eq for FrontmatterPolicy

impl PartialEq for FrontmatterPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FrontmatterPolicy