Struct Document 

pub struct Document {
    pub meta: DocumentMeta,
    pub frontmatter: FrontMatter,
    pub content: String,
    pub rendered_content: Option<String>,
    pub span: Span,
}

文档

Fields

meta: DocumentMeta

文档元信息

frontmatter: FrontMatter

前置元数据（frontmatter）

content: String

文档内容（原始文本）

rendered_content: Option<String>

解析后的内容（可以是 HTML 或结构化数据）

span: Span

位置信息

Implementations

impl Document

pub fn new() -> Document

创建新的文档

pub fn with_path(self, path: String) -> Document

设置文档路径

pub fn with_frontmatter(self, frontmatter: FrontMatter) -> Document

设置前置元数据

pub fn with_content(self, content: String) -> Document

设置文档内容

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

获取文档标题

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

获取文档描述

pub fn tags(&self) -> &[String]

获取文档标签

pub fn to_json(&self) -> Result<String, Error>

序列化为 JSON

pub fn to_json_pretty(&self) -> Result<String, Error>

序列化为美化的 JSON

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>( __deserializer: __D, ) -> Result<Document, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Document

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Document