Struct Esc

pub struct Esc<T: AsRef<str>>(pub T);

A formatting wrapper for escaping HTML in a string.

The Display implementation replaces

• & with &
• < with <
• > with >
• " with "
• ' with '

Esc is lazy: If you don’t use it, it does nothing. Also, it doesn’t allocate a String unless you call .to_string().

Examples

In a format!-like macro:

assert_eq!(&format!("{}", Esc("<h1>")), "&lt;h1&gt;");

Convert it to a String directly:

assert_eq!(&Esc("<h1>").to_string(), "&lt;h1&gt;");

Tuple Fields

0: T

Trait Implementations

impl<T: Clone + AsRef<str>> Clone for Esc<T>

fn clone(&self) -> Esc<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + AsRef<str>> Debug for Esc<T>

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

Formats the value using the given formatter.

impl<T: AsRef<str>> Display for Esc<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + AsRef<str>> PartialEq for Esc<T>

fn eq(&self, other: &Esc<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Copy + AsRef<str>> Copy for Esc<T>

impl<T: Eq + AsRef<str>> Eq for Esc<T>

impl<T: AsRef<str>> StructuralPartialEq for Esc<T>