Enum FrontMatterFormat 

#[non_exhaustive]
pub enum FrontMatterFormat {
    Yaml,
    Toml,
    Json,
}

Which front-matter shape a document carries, and where its body starts.

Returned by detect_front_matter; the byte offset is the first byte after the closing delimiter, so &content[body_start..] is the body.

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.

Yaml

--- fenced YAML.

Toml

+++ fenced TOML.

Json

A JSON object at the top of the document.

Implementations

impl FrontMatterFormat

pub const fn as_str(self) -> &'static str

The format’s lower-case name: yaml, toml or json.

Trait Implementations

impl Clone for FrontMatterFormat

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FrontMatterFormat

impl Debug for FrontMatterFormat

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

Formats the value using the given formatter.

impl Display for FrontMatterFormat

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

Formats the value using the given formatter.

impl Eq for FrontMatterFormat

impl Hash for FrontMatterFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FrontMatterFormat

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FrontMatterFormat