Enum HtmlContext 

#[non_exhaustive]
pub enum HtmlContext {
    Unescaped,
    Text,
    AttributeValue,
    Comment,
    AttributeKey,
    ElementName,
}

The position in an HTML document that a dynamic value is written into.

Writing through a context makes the value safe for that position. Contexts where HTML provides an escape mechanism rewrite the significant characters; ident contexts, where character references are never decoded, validate instead and panic on characters that could break out of the position:

Context	&	<	>	"	Other
Unescaped	-	-	-	-	-
Text	&amp;	&lt;	&gt;	-	-
AttributeValue	&amp;	-	-	&quot;	-
Comment	&amp;	-	&gt;	&quot;	-
AttributeKey	-	panic	panic	panic	see below
ElementName	-	panic	panic	panic	see below

The ident contexts reject ASCII whitespace, ASCII control characters, ", ', <, >, /, and =: the characters the HTML tokenizer can treat as ending or altering a name token. This guarantees the identifier cannot terminate or corrupt its token; it does not check full spec validity.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unescaped

Trusted markup written verbatim.

Text

A text node between tags. Quotes are not significant here, so the three escapable characters are found with a single search.

AttributeValue

A double-quoted attribute value. Only & and " can terminate or alter the value, found with a single search.

Comment

A machine-readable payload inside an HTML comment, such as the markers the interactive runtime emits. Escaping > guarantees the payload cannot contain --> and terminate the comment, while & and " round-trip through entity decoding so double-quoted strings inside the payload stay unambiguous. Comment data is never entity-decoded by the browser, so the consumer of the payload must decode it.

AttributeKey

An attribute name, validated as an identifier rather than escaped.

ElementName

A tag name, validated as an identifier rather than escaped.

Implementations

impl HtmlContext

pub fn writer<'a, 'b>(self, f: &'a mut Formatter<'b>) -> HtmlWriter<'a, 'b>

Returns a writer that makes everything written to it safe for this context before appending it to f.

Trait Implementations

impl Clone for HtmlContext

fn clone(&self) -> HtmlContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HtmlContext

impl Debug for HtmlContext

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

Formats the value using the given formatter.

impl Eq for HtmlContext

impl PartialEq for HtmlContext

fn eq(&self, other: &HtmlContext) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HtmlContext