Struct Safe

pub struct Safe<T>(pub T);

Mark the output of a filter as “safe”

This struct can be used as a transparent return type of custom filters that want to mark their output as “safe” no matter what, i.e. that their output does not need to be escaped.

If the filter is not used as the last element in the filter chain, then any assumption is void. Let the next filter decide if the output is safe or not.

Example

mod filters {
    use askama::{filters::Safe, Result};

    // Do not actually use this filter! It's an intentionally bad example.
    pub fn strip_except_apos(s: impl ToString) -> Result<Safe<String>> {
        Ok(Safe(s
            .to_string()
            .chars()
            .filter(|c| !matches!(c, '<' | '>' | '"' | '&'))
            .collect()
        ))
    }
}

#[derive(askama::Template)]
#[template(
    source = "<div class='{{ klass|strip_except_apos }}'></div>",
    ext = "html"
)]
struct DivWithClass<'a> {
    klass: &'a str,
}

assert_eq!(
    DivWithClass { klass: "<&'lifetime X>" }.to_string(),
    "<div class=''lifetime X'></div>",
);

Tuple Fields

0: T

Trait Implementations

impl<T: Display> Display for Safe<T>

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

Formats the value using the given formatter.

impl<T: FastWritable> FastWritable for Safe<T>

fn write_into<W: Write + ?Sized>(&self, dest: &mut W) -> Result<()>

Used internally by askama to speed up writing some types.