Struct Template

pub struct Template {
    pub id: String,
    pub contents: String,
    pub group: String,
    pub context_mode: ContextMode,
    pub structure_mode: StructureMode,
    pub extension: String,
    pub names: Names,
}

A struct representing a fully configured template.

Fields

id: String

The template’s id.

This is the file path relative to the templates directory. It serves to identify a template within the registry when rendering.

--> /path/to/templates/nested/template.md
-->                    nested/template.md

contents: String

The unparsed contents of the template.

This gets parsed and validated during template registration.

group: String

The template’s group name.

See StructureMode::FlatGrouped and StructureMode::NestedGrouped for more information.

context_mode: ContextMode

The template’s context mode i.e what the template intends to render.

See ContextMode for more information.

structure_mode: StructureMode

The template’s structure mode i.e. how the output should be structured.

See StructureMode for more information.

extension: String

The template’s file extension.

names: Names

The template strings for generating output file and directory names.

Implementations

impl Template

pub fn new<P>(path: P, string: &str) -> Result<Self>

where P: AsRef<Path>,

Creates a new instance of Template.

Arguments

• path - The path to the template relative to the templates directory.
• string - The contents of the template file.

Errors

Will return Err if:

• The template’s opening and closing config tags have syntax errors.
• The tempalte’s config has syntax errors or is missing required fields.

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Template

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Template

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.