Struct TemplateEngineLoader

pub struct TemplateEngineLoader {
    pub template_location: String,
    pub extra_config_location: Option<String>,
}

Available on crate feature tera-loader only.

Helps loading Templates from disk along with a handy configuration file.

Templates should be placed in a flat file structure in one directory. They may be accompanied by an extra.toml file. (by default, the location is configurable)

It also helps out a bit with deriving template realted configuration for the rest of whatever you are building.

Example:

use lib_humus::TemplateEngineLoader;
 
let template_loader = TemplateEngineLoader::new(
	config.template.template_location.clone(),
	config.template.extra_config.clone()
)
	.cli_template_location(cli_args.template_location)
	.cli_extra_config_location(cli_args.extra_config);
 	
 
let templating_engine = match template_loader.load_templates() {
	Ok(t) => t.into(),
	Err(e) => {
		println!("{e}");
		::std::process::exit(1);
	}
};

Fields

template_location: String

The path to the directory where the templates are.

extra_config_location: Option<String>

The path to the extra configuration (relative to the current pwd, not to the templates)

Implementations

impl TemplateEngineLoader

pub fn new( template_location: String, extra_config_location: Option<String>, ) -> Self

Creates a new TemplateEngineLoader with minimal typing.

pub fn cli_template_location(self, location: Option<String>) -> Self

Overrides the template location with a new location if it is set.

Intended for processing cli-options.

pub fn cli_extra_config_location(self, location: Option<String>) -> Self

Overrides the extra configuration location with a new location if it is set.

Intended for processing cli-options.

pub fn base_dir(&self) -> String

Returns the template base directory.

Contructed by ensuring the template_location ends in a “/”.

pub fn load_templates( &self, ) -> Result<HumusProtoEngine, TemplateEngineLoaderError>

Initialize a HumusProtoEngine with the given templates and extra configuration.

Failure Modes:

• The extra.toml was not found and the path was explicitly set.
• The extra.toml was found and is not valid toml.
• The extra.toml passes, but tera finds an error in the templates.

If extra_config_location is None no error is returned if the extra.toml was not found as the template might not require one.

Trait Implementations

impl Clone for TemplateEngineLoader

fn clone(&self) -> TemplateEngineLoader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateEngineLoader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TemplateEngineLoader

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.