Struct CompiledTemplates

pub struct CompiledTemplates { /* private fields */ }

CompiledTemplates is useful when you have a set of templates that you will expand frequently in a tight loop. Because the underlying crate returns only references to Templates, it is a covariant, self-referential structure that needs to be constructed like this:

fn get_templates<'b>(
  engine: &'b TemplateEngine
) -> anyhow::Result<TemplateList<'b>> {
  let mut templates = vec![];
  templates.push(engine.get_template("something")?);
  Ok(templates)
}

let engine = TemplateEngine::new();
engine.add_template("something", "some text")?;
let compiled = CompiledTemplates::try_new(engine, |engine| {
  get_templates(engine)
});

Implementations

impl CompiledTemplates

pub fn new( owner: TemplateEngine, dependent_builder: impl for<'_q> FnOnce(&'_q TemplateEngine) -> TemplateList<'_q>, ) -> Self

Constructs a new self-referential struct.

The provided owner will be moved into a heap allocated box. Followed by construction of the dependent value, by calling dependent_builder with a shared reference to the owner that remains valid for the lifetime of the constructed struct.

pub fn try_new<Err>( owner: TemplateEngine, dependent_builder: impl for<'_q> FnOnce(&'_q TemplateEngine) -> Result<TemplateList<'_q>, Err>, ) -> Result<Self, Err>

Constructs a new self-referential struct or returns an error.

Consumes owner on error.

pub fn try_new_or_recover<Err>( owner: TemplateEngine, dependent_builder: impl for<'_q> FnOnce(&'_q TemplateEngine) -> Result<TemplateList<'_q>, Err>, ) -> Result<Self, (TemplateEngine, Err)>

Constructs a new self-referential struct or returns an error.

Returns owner and error as tuple on error.

pub fn borrow_owner<'_q>(&'_q self) -> &'_q TemplateEngine

Borrows owner.

pub fn with_dependent<'outer_fn, Ret>( &'outer_fn self, func: impl for<'_q> FnOnce(&'_q TemplateEngine, &'outer_fn TemplateList<'_q>) -> Ret, ) -> Ret

Calls given closure func with a shared reference to dependent.

pub fn with_dependent_mut<'outer_fn, Ret>( &'outer_fn mut self, func: impl for<'_q> FnOnce(&'_q TemplateEngine, &'outer_fn mut TemplateList<'_q>) -> Ret, ) -> Ret

Calls given closure func with an unique reference to dependent.

pub fn borrow_dependent<'_q>(&'_q self) -> &'_q TemplateList<'_q>

Borrows dependent.

pub fn into_owner(self) -> TemplateEngine

Consumes self and returns the the owner.

Trait Implementations

impl Drop for CompiledTemplates

fn drop(&mut self)

Executes the destructor for this type.