Struct dysql::Ramhorns

pub struct Ramhorns<H = BuildHasherDefault<FnvHasher>> { /* private fields */ }

Aggregator for Templates, that allows them to be loaded from the file system and use partials: {{>partial}}

For faster or DOS-resistant hashes, it is recommended to use aHash RandomState as hasher.

Implementations

impl<H> Ramhorns<H>

where H: BuildHasher + Default,

pub fn from_folder<P>(dir: P) -> Result<Ramhorns<H>, TemplateError>

where P: AsRef<Path>,

Loads all the .html files as templates from the given folder, making them accessible via their path, joining partials as required. If a custom extension is wanted, see [from_folder_with_extension]

let tpls: Ramhorns = Ramhorns::from_folder("./templates").unwrap();
let content = "I am the content";
let rendered = tpls.get("hello.html").unwrap().render(&content);

pub fn from_folder_with_extension<P>( dir: P, extension: &str ) -> Result<Ramhorns<H>, TemplateError>

where P: AsRef<Path>,

Loads all files with the extension given in the extension parameter as templates from the given folder, making them accessible via their path, joining partials as required.

let tpls: Ramhorns = Ramhorns::from_folder_with_extension("./templates", "mustache").unwrap();
let content = "I am the content";
let rendered = tpls.get("hello.mustache").unwrap().render(&content);

pub fn extend_from_folder<P>(&mut self, dir: P) -> Result<(), TemplateError>

where P: AsRef<Path>,

Extends the template collection with files with .html extension from the given folder, making them accessible via their path, joining partials as required. If there is a file with the same name as a previously loaded template or partial, it will not be loaded.

pub fn extend_from_folder_with_extension<P>( &mut self, dir: P, extension: &str ) -> Result<(), TemplateError>

where P: AsRef<Path>,

Extends the template collection with files with extension from the given folder, making them accessible via their path, joining partials as required. If there is a file with the same name as a previously loaded template or partial, it will not be loaded.

pub fn lazy<P>(dir: P) -> Result<Ramhorns<H>, TemplateError>

where P: AsRef<Path>,

Create a new empty aggregator for a given folder. This won’t do anything until a template has been added using from_file.

let mut tpls: Ramhorns = Ramhorns::lazy("./templates").unwrap();
let content = "I am the content";
let rendered = tpls.from_file("hello.html").unwrap().render(&content);

pub fn get(&self, name: &str) -> Option<&Template>

Get the template with the given name, if it exists.

pub fn from_file(&mut self, name: &str) -> Result<&Template, TemplateError>

Get the template with the given name. If the template doesn’t exist, it will be loaded from file and parsed first.

Use this method in tandem with lazy.