Struct Frontmatter 

pub struct Frontmatter {
    pub title: Option<String>,
    pub published: Option<String>,
    pub cover: Option<String>,
    pub model: Option<String>,
    pub theme: Option<String>,
    pub code: Option<String>,
    pub description: String,
    pub other: Value,
}

YAML frontmatter structure for markdown files.

This struct represents the frontmatter that can be present at the beginning of markdown files. It supports common fields like title and published, and uses #[serde(flatten)] to capture any additional fields.

Examples

---
title: "My Article"
published: "draft"
author: "John Doe"
tags: ["rust", "wechat"]
theme: "lapis"
code: "github"
cover: "cover.png"
---

Fields

title: Option<String>

The title of the article. Optional field that will be omitted from serialization if not present.

published: Option<String>

Publication status of the article.

Common values:

• None or missing: not uploaded
• "draft": uploaded as draft to WeChat
• "true": published (will be skipped in directory mode)

cover: Option<String>

Cover image filename for the article. If missing, the system will attempt to generate one using AI.

model: Option<String>

Image generation model alias.

Available models: nb2 (default, Gemini Flash), nb (Gemini Pro), gpt (OpenAI)

theme: Option<String>

Theme for the WeChat article styling.

Available themes: default, lapis, maize, orangeheart, phycat, pie, purple, rainbow

code: Option<String>

Code highlighter for syntax highlighting.

Available highlighters: github, github-dark, vscode, atom-one-light, atom-one-dark, solarized-light, solarized-dark, monokai, dracula, xcode

description: String

Description of the article.

other: Value

Captures any additional fields in the frontmatter that are not explicitly defined in this struct.

Implementations

impl Frontmatter

pub fn new() -> Self

Creates a new empty frontmatter

pub fn with_title(title: impl Into<String>) -> Self

Creates a frontmatter with a title

pub fn set_title(&mut self, title: impl Into<String>)

Sets the title

pub fn set_published(&mut self, status: impl Into<String>)

Sets the published status

pub fn set_cover(&mut self, cover: impl Into<String>)

Sets the cover image

pub fn set_theme(&mut self, theme: impl Into<String>)

Sets the theme

pub fn set_code_highlighter(&mut self, code: impl Into<String>)

Sets the code highlighter

pub fn is_published(&self) -> bool

Checks if the article is published

pub fn is_draft(&self) -> bool

Checks if the article is a draft

pub fn is_unpublished(&self) -> bool

Checks if the article is unpublished

pub fn effective_model(&self) -> &str

Returns the effective model alias, defaulting to “nb2”

pub fn validate(&self) -> Result<()>

Validates the frontmatter

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