Struct ferru::document::Document

pub struct Document { /* fields omitted */ }

A struct representation of a Ferru document, consisting of a YAML header and a String body.

Methods

impl Document

fn new(header: Header, content: &str) -> Document

Creates a new document from the provided Header and content &str.

fn as_html(&self) -> Result<String>

Renders the document content to a String, using the header data as the templating attributes.

fn render_to_file(
    &self,
    file_path: &Path,
    templates: &TemplateMap
) -> Result<()>

Renders the document to the desired file path, selecting the template specified in the "template" header field as the header from the list of provided templates.

Trait Implementations

impl PartialEq for Document

fn eq(&self, __arg_0: &Document) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Document) -> bool

This method tests for !=.

impl Debug for Document

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.