Enum FrontmatterItem 

pub enum FrontmatterItem {
    Field {
        key: String,
        value: QuillValue,
        fill: bool,
    },
    Comment {
        text: String,
        inline: bool,
    },
}

One entry in a Frontmatter: a field or a comment line.

Variants

Field

A YAML field (key-value pair), optionally tagged !fill.

Fields

key: String

value: QuillValue

fill: bool

true when the field was written as key: !fill <value> or key: !fill in source.

Comment

A YAML comment. Text excludes the leading # and one optional space.

inline distinguishes own-line comments (# text on a line by itself) from trailing inline comments (field: value # text). An inline comment attaches to the field that immediately precedes it in the items vector; if no such field exists at emit time (orphan) it degrades to an own-line comment. A Comment { inline: true } at items[0] instead attaches to the sentinel line (QUILL: … / CARD: …).

Fields

text: String

inline: bool

Implementations

impl FrontmatterItem

pub fn field(key: impl Into<String>, value: QuillValue) -> Self

Build a plain (non-fill) field entry.

pub fn comment(text: impl Into<String>) -> Self

Build an own-line comment item.

pub fn comment_inline(text: impl Into<String>) -> Self

Build an inline (trailing) comment item. Attaches to the previous field on emit; degrades to own-line if none exists.

Trait Implementations

impl Clone for FrontmatterItem

fn clone(&self) -> FrontmatterItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrontmatterItem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FrontmatterItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FrontmatterItem

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FrontmatterItem

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FrontmatterItem