Struct FrameDoc 

pub struct FrameDoc {
    pub path: String,
    pub source: String,
}

A document that frames every page — a site’s header or footer — as the text of the file and the path it was read from.

The path is load-bearing twice over: its extension decides the grammar the text is parsed in, and relative links in the text resolve against it.

Here rather than in [crate::site], which consumes it, because the caller that assembles one has only read a file: plates builds a FrameDoc from a vault without enabling templating, and the type it hands over cannot live behind a feature it does not turn on.

Fields

path: String

Vault-relative path, spelled the way SourceDoc::path is: no leading slash, extension included.

source: String

The file’s text, metadata block and all.

Trait Implementations

impl Clone for FrameDoc

fn clone(&self) -> FrameDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameDoc

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

Formats the value using the given formatter.

impl Eq for FrameDoc

impl PartialEq for FrameDoc

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FrameDoc