Struct TemplatingEngine 

pub struct TemplatingEngine<ApiFormat>
where
    ApiFormat: HumusApiFormat,
{
    pub tera: HashMap<HumusFormatIdentifier, Tera>,
    pub template_config: Option<ExtraConfig>,
    pub templates_manifest: TemplatesManifest,
    /* private fields */
}

Implements the actual data to text conversion using the tera crate.

Fields

tera: HashMap<HumusFormatIdentifier, Tera>

An instance of the tera templating engine.

template_config: Option<ExtraConfig>

If it was possible to read any extra configuration it will be stored here.

templates_manifest: TemplatesManifest

The template configuration read from the templates.toml manifest file.

Implementations

impl<ApiFormat> TemplatingEngine<ApiFormat>

where ApiFormat: HumusApiFormat,

pub fn load_from_directory( path: impl AsRef<Path>, extra_config_path: Option<&Path>, template_tera: Tera, language_engine: Option<Arc<LanguageEngine>>, ) -> Result<Self, TemplatingEngineLoaderError>

Load this templating engine from a path to a templates directory and an optional path to a template configuration file (extra.toml).

• tera expects an empty Tera engine, that you have already added your customizations to. Use Tera::default() if you do not need to customize.
• When a language_engine is supplied this automatically sets up the TextFunction (text() inside the template) with an implicit path to pass the language through.

The following is expeced inside the path:

• {path}/
  • tera2/ - A directory containing the tera templates (This is different from previous versions of lib-humus where the templates were in the path directly)
    • {view_id}.{format_extension} Each template must be named after the id of the view it represents taken from HumusView::get_template_name and the extension that is specified in the templates manifest.
    • Additional templates can be specified using the additional_templates key in each format description.
  • templates.toml - Must contain the templates manifest
  • extra.toml - Optional file that contains default template configuration is loaded from when extra_config_path is None.

pub fn render_view<S: HumusQuerySettings>( &self, settings: &S, view: impl HumusView<S, ApiFormat>, language_engine: &LanguageEngine, ) -> Response

Takes settings and a view, converting it to a serveable response.

Example:

async fn hello_world_handler(
	State(arc_state): State<Arc<ServiceSharedState>>,
	Extension(settings): Extension<QuerySettings>,
) -> Response {
	let state = Arc::clone(&arc_state);

	state.templating_engine.render_view(
		&settings,
		View::Message{
			title: "Hey There!".to_string(),
			message: "You are an awesome creature!".to_string()
		},
	)
}

This function can, depending on the provided settings and the ApiFormat type operate in either template mode or API mode.

It operates in API mode when the from_name() method of the ApiFormat type returns a Some, otherwise it operates in template mode.

If the requested format id neither resolves to a valid API nor an existing template a status code 400 and a response body starting with (unknown format) followed by a human readable error message is generated as the response.

In template mode the following happens:

• status code is fetched from the view.
• Template name and MimeType are fetched.
• The Template context is populated with metadata from the view and template_config. (Documentation linked below)
• The initalize_template_context() hook method is called on view.
• The template gets rendered, resulting in further processing or an error response.
• The response is constructed using the MimeType from earlier and the text from the template.
• The update_response() hook method is called on view
• If the status code of the response from get_api_response() is 200 it will be replaced with the result of the get_status_code() method of the view.

See also the writing templates documentation.

In API mode the following happens:

• status code is fetched from the view.
• The into_api_response() method of the view is used to generate an HTTP response.
• If the status code of the response from get_api_response() is 200 it will be replaced with the result of the get_status_code() method of the view.

Trait Implementations

impl<ApiFormat> Clone for TemplatingEngine<ApiFormat>

where ApiFormat: HumusApiFormat + Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ApiFormat> Debug for TemplatingEngine<ApiFormat>

where ApiFormat: HumusApiFormat + Debug,

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

Formats the value using the given formatter.