Skip to main content

Template

Struct Template 

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

A simple template engine for prompt templates.

Templates use {{VARIABLE}} syntax for placeholders and {{> partial}} for including shared templates. Variables are replaced with the provided values. Comments using {# comment #} syntax are stripped.

§Example

let partials = HashMap::from([("header", "Common Header\n")]);
let template = Template::new("{{> header}}\nReview this diff:\n{{DIFF}}");
let variables = HashMap::from([("DIFF", "+ new line")]);
let rendered = template.render_with_partials(&variables, &partials)?;

Implementations§

Source§

impl Template

Source

pub fn new(content: &str) -> Self

Create a template from a string.

Comments ({# ... #}) are stripped during creation. All features are enabled by default: variables, conditionals, loops, and defaults.

§

impl Template

pub fn render( &self, variables: &HashMap<&str, String>, ) -> Result<String, TemplateError>

Render the template with the provided variables.

§Errors

Returns error if the operation fails.

pub fn render_with_partials( &self, variables: &HashMap<&str, String>, partials: &HashMap<String, String>, ) -> Result<String, TemplateError>

Render the template with variables and partials support.

Partials are processed recursively, with the same variables passed to each partial. Circular references are detected and reported with a clear error.

§Errors

Returns error if the operation fails.

pub fn render_with_log( &self, template_name: &str, variables: &HashMap<&str, String>, partials: &HashMap<String, String>, ) -> Result<RenderedTemplate, TemplateError>

Render the template with variables and partials, returning substitution log.

This is the primary method for reducer-integrated rendering. It returns both the rendered content and a detailed log of all substitutions, enabling validation based on what was actually substituted rather than regex scanning.

§Errors

Returns error if the operation fails.

Trait Implementations§

Source§

impl Clone for Template

Source§

fn clone(&self) -> Template

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Template

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.