Struct Renderer

pub struct Renderer { /* private fields */ }

A struct providing a simple interface to build and render templates.

Implementations

impl Renderer

pub fn new<O>(options: O, default: String) -> Self

where O: Into<RenderOptions>,

Returns a new instance of Renderer.

Arguments

• options - The render options.
• default - A string representing the contents of a template to build as the default. Used when no templates directory is specified.

pub fn init(&mut self) -> Result<()>

Initializes Renderer by building Templates depending on whether a templates directory is provided or not. If none is provided then the default template is built.

Errors

Will return Err if:

• A template contains either syntax errors or contains variables that reference non-existent fields in a Book/Annotation.
• A template’s config block isn’t formatted correctly, has syntax errors or is missing required fields.
• A requested template-group does not exist.
• Any IO errors are encountered.

pub fn render(&mut self, entry: &Entry) -> Result<()>

Iterates through all Templates and renders them based on their StructureMode and ContextMode. See respective enums for more information.

Arguments

• entry - The entry to be rendered.

Errors

Will return Err if any IO errors are encountered.

pub fn write(&self, path: &Path) -> Result<()>

Iterates through all Renders and writes them to disk.

Arguments

• path - The path to the write the rendered templates to. Each rendered template’s path is appened to this path to determine its full path.

Errors

Will return Err if any IO errors are encountered.

pub fn templates_rendered(&self) -> impl Iterator<Item = &Render>

Returns an iterator over all Renders.

pub fn templates_rendered_mut(&mut self) -> impl Iterator<Item = &mut Render>

Returns a mutable iterator over all Renders.

pub fn count_templates(&self) -> usize

Returns the number of Templates.

pub fn count_templates_rendered(&self) -> usize

Returns the number of Renders.

Trait Implementations

impl Debug for Renderer

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

Formats the value using the given formatter.

impl Default for Renderer

fn default() -> Renderer

Returns the “default value” for a type.