Struct Sanitize 

pub struct Sanitize {
    pub allow_comments: Option<bool>,
    pub allow_doctypes: Option<bool>,
    pub ancestors: Option<HashMap<String, Vec<String>>>,
    pub attributes: Option<HashMap<String, Vec<AttributeDefinition>>>,
    pub clobber: Option<Vec<String>>,
    pub clobber_prefix: Option<String>,
    pub protocols: Option<HashMap<String, Vec<String>>>,
    pub required: Option<HashMap<String, BTreeMap<String, Primitive>>>,
    pub strip: Option<Vec<String>>,
    pub tag_names: Option<Vec<String>>,
}

html.sanitize: keep only what a schema allows; options: hast-util-sanitize’s schema, where a field left out keeps the default schema’s, which is GitHub’s.

Fields

allow_comments: Option<bool>

Keep comments.

allow_doctypes: Option<bool>

Keep doctypes.

ancestors: Option<HashMap<String, Vec<String>>>

Elements allowed only inside one of these ancestors, by tag name.

attributes: Option<HashMap<String, Vec<AttributeDefinition>>>

Properties allowed per tag name, * for every element; a list names a property and the values it may have.

clobber: Option<Vec<String>>

Properties whose values get clobber_prefix, so they cannot clobber globals.

clobber_prefix: Option<String>

The prefix of clobbered values.

protocols: Option<HashMap<String, Vec<String>>>

URL properties and the protocols they may use.

required: Option<HashMap<String, BTreeMap<String, Primitive>>>

Properties set on elements whatever they had, by tag name.

strip: Option<Vec<String>>

Elements dropped with their content rather than unwrapped.

tag_names: Option<Vec<String>>

The elements kept.

Trait Implementations

impl Clone for Sanitize

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sanitize

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

Formats the value using the given formatter.

impl Default for Sanitize

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Sanitize

where Sanitize: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Plugin for Sanitize

fn attach(&self, context: &mut Attach) -> Result<(), Error>

impl Transform for Sanitize

fn input(&self) -> TreeKind

fn output(&self) -> TreeKind

fn run<'a>( &self, tree: Tree<'a>, _file: &mut File, alloc: &'a Allocator, ) -> Result<Tree<'a>, Error>

fn start<'a>( &self, tree: Tree<'a>, file: &mut File, alloc: &'a Bump, ) -> Result<Step<'a>, Error>

Start the stage: a finished tree, or a job when its work is asynchronous.

fn host(&self) -> Option<u32>

The id of the binding function this stage stands for, which takes and returns whatever tree reaches it; None for a stage the crate runs.

fn html_writer(&self, _target: HtmlTarget) -> Option<Box<dyn HtmlWriter>>

Something that writes, from this stage’s input, the HTML a compiler aiming at target would write from its output, when the stage can skip building that tree.