Templates v0.0.3 → Overview → Sugar → Templates → Engine

Sugar.Templates.Engine behaviour

Types
Callbacks

Specification of the template engine API implemented by individual template engines.

Types ↑

template :: Sugar.Templates.Template.t

reason :: String.t

vars :: list | Keyword.t

Callbacks

compile/1

(callback) # ↑

Specs:

compile(template) :: {:ok, template} | {:error, reason}

Compiles a template.

It is advised that an engine implementation removes the template source from the struct if it is not needed after compilation but retain it if needed for rendering.

render/2

(callback) # ↑

Specs:

render(template, vars) :: {:ok, iodata}

Renders a compiled template based on the given template struct.