Struct Engine 

pub struct Engine { /* private fields */ }

A theme’s templates, compiled and ready to render.

Implementations

impl Engine

pub async fn build(db: &Db, code: &str) -> Result<Engine, ThemeError>

Compiles the theme code with its ancestors.

pub async fn build_with( db: &Db, code: &str, configure: impl FnOnce(&mut Environment<'static>), ) -> Result<Engine, ThemeError>

Like Engine::build, with a hook that adds the application’s own functions, filters and globals to the environment before the templates compile.

pub fn theme(&self) -> &Theme

The theme this engine renders.

pub fn stamp(&self) -> &str

Changes when the theme or an ancestor does; EngineCache compares it.

pub fn env(&self) -> &Environment<'static>

The environment, for a render path that needs more than Engine::render.

pub fn names(&self) -> &[String]

Every compiled template’s name, sorted.

pub fn resolve(&self, path: &str) -> Option<(&str, Params)>

The page a request path resolves to, with its parameters.

pub fn page(&self, name: &str) -> Option<&PageSettings>

A page’s settings by name (its path without the extension).

pub fn page_path(&self, name: &str) -> Option<&str>

A page’s stored path by name.

pub fn layout_settings(&self, path: &str) -> Option<&Value>

A layout’s settings bag by path.

pub fn page_bag(&self, name: &str) -> Option<&Value>

A page’s whole settings bag by name, components included.

pub fn url_for(&self, name: &str, params: &Params) -> Option<String>

The URL of the page name with params.

pub fn routes(&self) -> &RouteTable

The route table: every page’s pattern in matching order.

pub fn has(&self, kind: Kind, path: &str) -> bool

Whether the theme, or an ancestor, has this template.

pub fn render( &self, kind: Kind, path: &str, ctx: impl Serialize, ) -> Result<String, RenderError>

Renders a template with ctx as its variables.

pub fn author_line(&self, err: RenderError) -> RenderError

An error’s line as the author sees it, for a page the engine composed.