Struct HtmlFormatter 

pub struct HtmlFormatter<'a>(/* private fields */);

A formatter for building HTML content safely and efficiently.

HtmlFormatter provides methods for constructing HTML by writing tags, attributes, and content to an underlying Html buffer. It handles HTML escaping automatically when using the *_escaped methods, helping prevent XSS vulnerabilities.

Note

This type should not be used directly. Instead, use the html! macro with render or render_with_capacity functions.

Usage

use plait::{Html, HtmlFormatter};

let mut html = Html::new();
let mut f = HtmlFormatter::new(&mut html);

f.open_tag("div");
f.write_attribute_escaped("class", "container");
f.close_start_tag();
f.write_html_escaped("<script>alert('xss')</script>");
f.close_tag("div");

assert_eq!(html, "<div class=\"container\">&lt;script&gt;alert(&#39;xss&#39;)&lt;/script&gt;</div>");

Implementations

impl<'a> HtmlFormatter<'a>

pub fn new(html: &'a mut Html) -> Self

Create a new HtmlFormatter for the given Html string.

pub fn open_tag(&mut self, tag_name: &str)

Opens a tag with the given name.

pub fn close_start_tag(&mut self)

Closes start tag (should be called after writing attributes).

pub fn close_tag(&mut self, tag_name: &str)

Closes a tag with the given name.

pub fn write_raw(&mut self, raw: impl Display)

Write HTML content to the formatter without escaping any special HTML characters.

pub fn write_html_escaped(&mut self, html: impl Display)

Write HTML content to the formatter, escaping any special HTML characters.

pub fn write_attribute_raw(&mut self, name: &str, value: impl Display)

Write an attribute to the formatter without escaping any special HTML characters.

pub fn write_attribute_escaped(&mut self, name: &str, value: impl Display)

Write an attribute to the formatter, escaping any special HTML characters in value.

pub fn write_maybe_attribute_raw(&mut self, name: &str, value: impl MaybeAttr)

Write an optional or boolean attribute to the formatter without escaping any special HTML characters.

pub fn write_maybe_attribute_escaped( &mut self, name: &str, value: impl MaybeAttr, )

Write an optional or boolean attribute to the formatter, escaping any special HTML characters in value.

pub fn write_optional_attribute_raw( &mut self, name: &str, value: Option<impl Display>, )

Write an optional attribute to the formatter without escaping any special HTML characters.

pub fn write_optional_attribute_escaped( &mut self, name: &str, value: Option<impl Display>, )

Write an optional attribute to the formatter, escaping any special HTML characters in value.

pub fn write_url_attribute_escaped(&mut self, name: &str, value: &str)

Write an URL attribute to the formatter, escaping any special HTML characters in value.

pub fn write_optional_url_attribute_escaped( &mut self, name: &str, value: Option<&str>, )

Write an optional URL attribute to the formatter, escaping any special HTML characters in value.

pub fn write_boolean_attribute(&mut self, name: &str, value: bool)

Write a boolean attribute to the formatter.