Struct Frontmatter 

pub struct Frontmatter {
    pub value: String,
    pub info: String,
    pub fence: char,
    pub fence_length: usize,
    pub closing_fence_length: usize,
    pub position: Option<Position>,
}

Language-agnostic frontmatter with an opaque format hint.

The contents are raw text: the Markdown parser does not interpret the named language. Untagged --- and +++ forms retain their legacy Yaml and Toml nodes; tagged forms and language-tagged code fences use this node.

Fields

value: String

Raw content between the fence lines, including its trailing line ending.

info: String

The whole info string, with surrounding spaces and tabs removed. Escapes and character references remain literal, as in Markly.

fence: char

Opening fence marker: a backtick, tilde, dash, or plus.

fence_length: usize

Number of opening fence markers. Serialization may lengthen the fence to keep edited content from closing it prematurely.

closing_fence_length: usize

Number of closing fence markers. Closing code fences can be longer than their opening fence.

position: Option<Position>

Source position, including the fences.

Implementations

impl Frontmatter

pub fn language(&self) -> Option<&str>

Return the first ASCII-whitespace-separated word as a format or language hint. The parser does not validate or interpret this hint.

Trait Implementations

impl Clone for Frontmatter

fn clone(&self) -> Self

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

impl PartialEq for Frontmatter

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frontmatter