Struct mdbook_tera::TeraPreprocessor

pub struct TeraPreprocessor<C = StaticContextSource> { /* private fields */ }

A mdBook preprocessor that renders Tera.

Implementations

impl<C> TeraPreprocessor<C>

pub fn new(context: C) -> Self

Construct a Tera preprocessor given a context source.

pub fn include_templates<P>(
    &mut self,
    root: P,
    glob_str: &str
) -> Result<(), Error> where
    P: AsRef<Path>, 

Includes Tera templates given a glob pattern and a root directory.

Errors

Returns an error if the provided path cannot be canonicalized or the inheritance chain can’t be built, such as adding a child template without the parent one.

pub fn tera_mut(&mut self) -> &mut Tera

Returns a mutable reference to the internal Tera engine.

Trait Implementations

impl<C: Clone> Clone for TeraPreprocessor<C>

fn clone(&self) -> TeraPreprocessor<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Default> Default for TeraPreprocessor<C>

fn default() -> Self

Returns the “default value” for a type.

impl<C> Preprocessor for TeraPreprocessor<C> where
    C: ContextSource, 

fn name(&self) -> &str

Get the Preprocessor’s name.

fn run(&self, book_ctx: &PreprocessorContext, book: Book) -> Result<Book, Error>

Run this Preprocessor, allowing it to update the book before it is given to a renderer.

fn supports_renderer(&self, _renderer: &str) -> bool

A hint to MDBook whether this preprocessor is compatible with a particular renderer.