Struct ammonia::Document

pub struct Document(_);

A sanitized HTML document.

The Document type is an opaque struct representing an HTML fragment that was sanitized by ammonia. It can be converted to a String or written to a Write instance. This allows users to avoid buffering the serialized representation to a String when desired.

This type is opaque to insulate the caller from breaking changes in the html5ever interface.

Note that this type wraps an html5ever DOM tree. ammonia does not support streaming, so the complete fragment needs to be stored in memory during processing. Currently, Document is backed by an html5ever::rcdom::Node object.

Examples

use ammonia::Builder;

let input = "<!-- comments will be stripped -->This is an Ammonia example.";
let output = "This is an Ammonia example.";

let document = Builder::new()
    .clean(input);
assert_eq!(document.to_string(), output);

Implementations

impl Document

pub fn to_string(&self) -> String

Serializes a Document instance to a String.

This method returns a String with the sanitized HTML. This is the simplest way to use ammonia.

Examples

use ammonia::Builder;

let input = "Some <style></style>HTML here";
let output = "Some HTML here";

let document = Builder::new()
    .clean(input);
assert_eq!(document.to_string(), output);

pub fn write_to<W>(&self, writer: W) -> Result<()> where
    W: Write, 

Serializes a Document instance to a writer.

This method writes the sanitized HTML to a Write instance, avoiding a buffering step.

To avoid consuming the writer, a mutable reference can be passed, like in the example below.

Note that the in-memory representation of Document is larger than the serialized String.

Examples

use ammonia::Builder;

let input = "Some <style></style>HTML here";
let expected = b"Some HTML here";

let document = Builder::new()
    .clean(input);

let mut sanitized = Vec::new();
document.write_to(&mut sanitized)
    .expect("Writing to a string should not fail (except on OOM)");
assert_eq!(sanitized, expected);

Trait Implementations

impl Clone for Document

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Display for Document

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

Formats the value using the given formatter.

impl From<Document> for String

fn from(document: Document) -> Self

Performs the conversion.