Struct rstml_component::Sanitized

pub struct Sanitized<V>(/* private fields */);

Available on crate feature sanitize only.

A wrapper struct for adding potentially unsanitized HTML content that will be sanitized before rendering.

The Sanitized struct allows you to include HTML content that might be potentially unsafe, and ensures that it’s properly sanitized before being rendered within your HTML components. This is particularly useful when you want to include user-generated content or any content that might contain unsafe HTML elements or scripts.

Implementations

impl<V> Sanitized<V>

where V: AsRef<[u8]>,

pub fn new(value: V) -> Self

Creates a new Sanitized instance with the HTML content to be sanitized before rendering.

Arguments

• value: The HTML content to be sanitized as a byte slice.

Returns

A Sanitized instance wrapping the HTML content that will be sanitized before rendering.

pub fn new_with_sanitizer(value: V, sanitizer: &'static SanitizeConfig) -> Self

Creates a new Sanitized instance with the HTML content and a custom sanitizer.

Arguments

• value: The HTML content to be sanitized as a byte slice.
• sanitizer: The custom sanitizer to be used for this specific instance.

Returns

A Sanitized instance wrapping the HTML content that will be sanitized using the specified sanitizer.

pub fn with_sanitizer(self, sanitizer: &'static SanitizeConfig) -> Self

Sets a custom sanitizer for this Sanitized instance.

This method allows you to override the default sanitizer for a specific Sanitized instance.

Arguments

• sanitizer: The custom sanitizer to be used for this specific instance.

Returns

A new Sanitized instance with the specified sanitizer.

Trait Implementations

impl<V: Clone> Clone for Sanitized<V>

fn clone(&self) -> Sanitized<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for Sanitized<V>

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

Formats the value using the given formatter.

impl<V: AsRef<[u8]>> HtmlContent for Sanitized<V>

fn fmt(self, formatter: &mut HtmlFormatter<'_>) -> Result

Formats the content and writes it to the provided HtmlFormatter.

fn write_to(self, buffer: &mut BytesMut) -> Result

Writes the formatted content to the provided byte buffer.

fn into_bytes(self) -> Result<Bytes, Error>

Converts the formatted content into a Bytes buffer.

fn into_string(self) -> Result<String, Error>

Converts the formatted content into a String.