Struct Trusted 

pub struct Trusted(/* private fields */);

A string that is markup, and is written into a document unescaped.

The invariant is the whole type: whatever is inside is already safe to appear between tags. Every way of building one either escapes what it is given (escaping, push) or is an explicit claim by the caller (from_markup, to_trusted) — so the places worth auditing are exactly the ones that name trust.

Implementations

impl Trusted

pub const fn new() -> Self

An empty document.

pub const fn from_markup(markup: String) -> Self

Take markup as markup, unescaped.

This is the claim. It is const and free — no scan, no copy — because the point of the type is to make the claim once, where the markup is built, rather than at every place it is written.

pub fn escaping(value: &dyn Display) -> Self

Escape value into a new document.

The inverse of from_markup: this one is always safe, whatever the value came from.

pub fn as_str(&self) -> &str

Borrow the markup.

pub fn into_string(self) -> String

Take the markup, giving up the claim that it is markup.

pub fn is_empty(&self) -> bool

Whether there is nothing to write.

pub fn len(&self) -> usize

The markup’s length in bytes.

pub fn push(&mut self, content: &impl Content)

Append content, escaping it if it is not already markup.

This is SafeBuffer#<<: a &str arrives escaped, another Trusted arrives whole, and neither call site has to remember which.

pub fn push_markup(&mut self, markup: &str)

Append markup unescaped — the claim from_markup makes, for a document being built up.

pub fn push_escaped(&mut self, value: &dyn Display)

Append value’s Display output, escaped.

impl Trusted

pub fn sink(&mut self) -> Sink<'_>

Borrow this document as a Renderer, to write attributes into.

Trait Implementations

impl AsRef<str> for Trusted

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Trusted

fn clone(&self) -> Trusted

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Content for Trusted

fn write_content(&self, out: &mut Trusted)

Write this content into out, escaping it unless it is already markup.

impl Debug for Trusted

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

Formats the value using the given formatter.

impl Default for Trusted

fn default() -> Trusted

Returns the “default value” for a type.

impl Eq for Trusted

impl From<Trusted> for String

fn from(trusted: Trusted) -> String

Converts to this type from the input type.

impl Hash for Trusted

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Trusted

fn cmp(&self, other: &Trusted) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Trusted

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Trusted

fn partial_cmp(&self, other: &Trusted) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Render for Trusted

fn render_into(&self, r: &mut dyn Renderer)

Write this content into r, with no slots filled.

fn render_slots(&self, r: &mut dyn Renderer, _slots: Slots<'_>)

Write this content into r, resolving its <slot>s against slots.

impl StructuralPartialEq for Trusted

impl Value for Trusted

fn write_value(&self, r: &mut dyn Renderer)

Write this value into r, escaping it unless it is already markup.

impl Value for &Trusted

fn write_value(&self, r: &mut dyn Renderer)

Write this value into r, escaping it unless it is already markup.