Skip to main content

TemplateEngine

Struct TemplateEngine 

Source
pub struct TemplateEngine { /* private fields */ }
Expand description

A template engine over a directory of templates.

A view name is dotted and maps to a path: posts.show → <root>/posts/show.view.html.

Implementations§

Source§

impl TemplateEngine

Source

pub fn new(root: impl Into<PathBuf>) -> Self

Load templates from root, caching parsed output.

Source

pub fn without_cache(self) -> Self

Re-read and re-parse templates on every render.

Source

pub fn with_extension(self, extension: impl Into<String>) -> Self

Use a different file extension.

Source

pub fn root(&self) -> &Path

Where templates are read from.

Source

pub fn path_for(&self, name: &str) -> PathBuf

The file a view name maps to.

Every segment is sanitised and the result is always inside the template root. That matters because a view name can reach the engine from a template (@include('…')) and, in a careless application, from user input. Naively replacing dots with separators is not enough: a name like ..secrets produces a leading separator, and Path::join with a rooted path discards the base — silently reading from the filesystem root.

Source

pub fn flush(&self)

Discard every cached template.

Trait Implementations§

Source§

impl Debug for TemplateEngine

Source§

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

Formats the value using the given formatter. Read more
Source§

impl ViewEngine for TemplateEngine

Source§

fn render(&self, name: &str, data: &Value) -> Result<String>

Render name with data.
Source§

fn exists(&self, name: &str) -> bool

Whether name resolves to a template.
Source§

fn render_view(&self, view: &View) -> Result<String>

Render a View.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.