Struct Handlebars

pub struct Handlebars { /* private fields */ }

Serialize response values using Handlebars templates

This serializer is able to render handlebar templates using structs with #[derive(Response)] and a template name, set with the #[web(template = "<template name>")] annotation.

Implementations

impl Handlebars

pub fn new() -> Handlebars

Create a new handlebars serializer.

The serializer renders handlebar templates using the response value to populate template variables. The response value must have #[derive(Response)] and a template name specified using the #[web(template = "<template name>")].

Templates are loaded from one of the following locations, checked in order:

1. A templates directory under the TOWER_WEB_TEMPLATE_DIR environment variable
2. A templates directory under the crate root (CARGO_MANIFEST_DIR environment variable)
3. A templates directory under the current working directory.

Templates have the .hbs file extension.

For more control over how templates are loaded, use new_with_registry.

pub fn new_with_registry(registry: Registry) -> Handlebars

Create a new handlebars serializer.

Similar to new, but uses the provided registry. This allows customizing how templates are rendered.

Trait Implementations

impl Clone for Handlebars

fn clone(&self) -> Handlebars

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Handlebars

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

Formats the value using the given formatter.

impl Serializer for Handlebars

type Format = ()

A token used by Serializer implementations to identify the specific serialization format to use when encoding a value.

fn lookup(&self, name: &str) -> Option<ContentType<Self::Format>>

Lookup a serializer and HeaderValue for the given Content-Type string.

fn serialize<T>( &self, value: &T, _: &Self::Format, context: &SerializerContext<'_>, ) -> Result<Bytes, Error>

where T: Serialize,

Serialize the value using the specified format.