Skip to main content

Engine

Struct Engine 

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

The forge rendering engine.

Wrap Tera with:

  • Custom filters: snake_case, pascal_case, camel_case, kebab_case
  • Import hoisting filters: collect_import, collect_import_priority
  • Import drain function: render_imports()
  • Tier-aware template registry

Implementations§

Source§

impl Engine

Source

pub fn new() -> Self

Create an engine with all forge extensions registered. No templates loaded yet.

Source

pub fn load_dir(&mut self, dir: &Path) -> Result<(), ForgeError>

Load all .jinja and .forge template files from dir recursively. Template names are relative paths from dir with forward slashes.

Source

pub fn load_embedded( &mut self, templates: &[(&str, &str)], ) -> Result<(), ForgeError>

Load templates from embedded (name, content) pairs (for binary embedding).

Source

pub fn add_raw(&mut self, name: &str, content: &str) -> Result<(), ForgeError>

Add a single raw template by name and content string.

Source

pub fn render( &self, name: &str, ctx: &ForgeContext, ) -> Result<String, ForgeError>

Render a template by name with the given context. Resets the ImportCollector and populates slots before rendering.

Source

pub fn render_continue( &self, name: &str, ctx: &ForgeContext, ) -> Result<String, ForgeError>

Render without resetting the ImportCollector or slots. Use when rendering multiple templates in sequence and collecting all their imports.

Source

pub fn tier_of(&self, name: &str) -> Tier

Return the tier of a template based on its path.

Source

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

Check whether a template with this name is loaded.

Trait Implementations§

Source§

impl Default for Engine

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V