Struct Document 

pub struct Document {

    pub source_path: PathBuf,
    pub output_path: PathBuf,
    pub title: String,
    pub content: DocumentContent,
    pub metadata: DocumentMetadata,
    pub html: String,
    pub source_mtime: DateTime<Utc>,
    pub build_time: DateTime<Utc>,
    pub cross_refs: Vec<CrossReference>,
    pub toc: Vec<TocEntry>,
    pub toctrees: Vec<ToctreeRecord>,
    pub directive_records: Vec<DirectiveRecord>,
    pub role_records: Vec<RoleRecord>,
    pub labels: Vec<LabelRecord>,
    pub registry: RegistryExport,
}

Fields

source_path: PathBuf

Source file path

output_path: PathBuf

Output file path

title: String

Document title

content: DocumentContent

Document content (parsed)

metadata: DocumentMetadata

Document metadata

html: String

Rendered HTML content

source_mtime: DateTime<Utc>

Source file modification time

build_time: DateTime<Utc>

Build time

cross_refs: Vec<CrossReference>

Cross-references found in this document

toc: Vec<TocEntry>

Table of contents

toctrees: Vec<ToctreeRecord>

Toctree directives found in this document (wave 3: derived from the doctree at parse time; the build resolves/warns).

directive_records: Vec<DirectiveRecord>

Directive occurrences for the validation system.

role_records: Vec<RoleRecord>

Role occurrences for validation + nitpicky cross-ref checking.

labels: Vec<LabelRecord>

Explicit hyperlink-target labels (docutils-normalized names).

registry: RegistryExport

The parse’s id/name registry snapshot (docutils document.nameids), which the std-domain label harvest consumes. It rides the Document — rather than being a separate read-phase value — so an incremental cache hit, which skips parsing entirely, still has the real registry instead of an empty stand-in. Deliberately not #[serde(default)]: a cache entry written before this field existed fails to decode and is re-parsed, which is the honest outcome.

Implementations

impl Document

pub fn new(source_path: PathBuf, output_path: PathBuf) -> Self

pub fn set_title(&mut self, title: String)

pub fn add_cross_ref(&mut self, cross_ref: CrossReference)

pub fn add_toc_entry(&mut self, entry: TocEntry)

pub fn set_html(&mut self, html: String)

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Document

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

where __S: Serializer,

Serialize this value into the given Serde serializer.