TemplateRenderer

Struct TemplateRenderer 

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

Template renderer with Tera engine and custom functions.

This struct wraps a Tera instance with AGPM-specific configuration, custom functions, and filters. It provides a safe, sandboxed environment for rendering Markdown templates.

§Security

The renderer is configured with security restrictions:

  • No file system access via includes/extends (except content filter)
  • No network access
  • Sandboxed template execution
  • Custom functions are carefully vetted
  • Project file access restricted to project directory with validation

Implementations§

Source§

impl TemplateRenderer

Source

pub fn new( enabled: bool, project_dir: PathBuf, max_content_file_size: Option<u64>, ) -> Result<Self>

Create a new template renderer with AGPM-specific configuration.

§Arguments
  • enabled - Whether templating is enabled globally
  • project_dir - Project root directory for content filter validation
  • max_content_file_size - Maximum file size in bytes for content filter (None for no limit)
§Returns

Returns a configured TemplateRenderer instance with custom filters registered.

§Filters

The following custom filters are registered:

  • content: Read project-specific files with path validation and size limits
Source

pub fn render_template( &mut self, template_content: &str, context: &TeraContext, metadata: Option<&RenderingMetadata>, ) -> Result<String, TemplateError>

Render a Markdown template with the given context.

This method supports recursive template rendering where project files can reference other project files using the content filter. Rendering continues up to filters::MAX_RENDER_DEPTH levels deep.

Render a Markdown template with the given context.

This method processes template syntax using the Tera engine. Content within

placeholders before processing, then restoring it afterwards.

# Arguments

* `template_content` - The raw Markdown template content
* `context` - The template context containing variables

# Returns

Returns the rendered Markdown content.

# Errors

Returns an error if:
- Template syntax is invalid
- Context variables are missing
- Custom functions/filters fail
- Recursive rendering exceeds maximum depth (10 levels)

# Literal Blocks

Content wrapped in ```literal fences will be protected from
template rendering and displayed literally:

````markdown
```literal
{{ agpm.deps.snippets.example.content }}
// This is a documentation example showing template syntax
// The actual template content would be in a separate file

This is useful for documentation that shows template syntax examples.

# Recursive Rendering

When a template contains 'content' filter references, those files
may themselves contain template syntax. The renderer automatically
detects this and performs multiple rendering passes until either:
- No template syntax remains in the output
- Maximum depth is reached (error)

Example recursive template chain:
// In a markdown file:
// # Main Agent
// {{ "docs/guide.md" | content }}

Where 'docs/guide.md' contains:
// # Guide
// {{ "docs/common.md" | content }}

This will render up to 10 levels deep.
Source

pub fn format_tera_error(error: &Error) -> String

Format a Tera error with detailed information about what went wrong.

Tera errors can contain various types of issues:

  • Missing variables (e.g., “Variable foo not found”)
  • Syntax errors (e.g., “Unexpected end of template”)
  • Filter/function errors (e.g., “Filter unknown not found”)

This function extracts the root cause and formats it in a user-friendly way, filtering out unhelpful internal template names like ‘__tera_one_off’.

§Arguments
  • error - The Tera error to format

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more