Struct Shortcodes

pub struct Shortcodes {
    pub functions: HashMap<String, fn(&HashMap<String, Value>) -> String>,
}

A struct that manages shortcode functions for use in Tera templates.

Fields

• functions: A HashMap where the key is the shortcode display name (a String), and the value is a function pointer that takes a reference to a HashMap of arguments and returns a String representing the generated content.

Fields

functions: HashMap<String, fn(&HashMap<String, Value>) -> String>

Implementations

impl Shortcodes

pub fn new() -> Self

Creates a new Shortcodes instance with an empty set of registered functions.

Returns

A Shortcodes struct with an empty functions map.

pub fn register( self, display: &str, shortcode_fn: fn(&HashMap<String, Value>) -> String, ) -> Self

Registers a new shortcode function in the Shortcodes struct.

Parameters

• display: The shortcode display name as a &str, which will be used as the key in the functions map.
• shortcode_fn: A function pointer that takes a HashMap of arguments and returns a String.

Returns

An updated instance of Shortcodes with the newly registered shortcode function.

Example

use tera_shortcodes::Shortcodes;
 
let shortcodes = Shortcodes::new().register("example", |args| {
    "Shortcode output".to_string()
});

Trait Implementations

impl Function for Shortcodes

fn call(&self, args: &HashMap<String, Value>) -> Result<Value>

Invokes a registered shortcode function by its display name.

Parameters

• args: A reference to a HashMap containing the arguments passed to the shortcode function.

Returns

A Result<tera::Value> that contains the generated content as a String or an error message if the display name is missing or unknown.

Error Handling

• If the display attribute is missing, it returns an error message "Missing display attribute".
• If no function is registered for the given display name, it returns an error message "Unknown shortcode display name: <display>".

fn is_safe(&self) -> bool

Whether the current function’s output should be treated as safe, defaults to false