Struct Frontmatter 

pub struct Frontmatter {
    pub template: Option<String>,
    pub title: Option<String>,
    pub author: Option<String>,
    pub date: Option<String>,
    pub metadata: BTreeMap<String, Value>,
}

Parsed YAML frontmatter used by smithy-md.

Fields

template: Option<String>

Optional template name (e.g. gov_proposal).

title: Option<String>

Optional document title.

author: Option<String>

Optional author name.

date: Option<String>

Optional document date string.

metadata: BTreeMap<String, Value>

Additional metadata payload.

Trait Implementations

impl Clone for Frontmatter

fn clone(&self) -> Frontmatter

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

fn default() -> Frontmatter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Frontmatter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Frontmatter

fn eq(&self, other: &Frontmatter) -> 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 Frontmatter

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 Frontmatter