Struct sanitize_html::rules::Rules

pub struct Rules {
    pub allow_comments: bool,
    pub allowed_elements: HashMap<String, Element>,
    pub delete_elements: HashSet<String>,
    pub space_elements: HashSet<String>,
    pub rename_elements: HashMap<String, String>,
}

structure to describe sanitization rules

Fields

allow_comments: bool

Determines if comments are kept of stripped out of a document.

allowed_elements: HashMap<String, Element>

Allowed elements.

delete_elements: HashSet<String>

Elements which will be removed together with their children.

space_elements: HashSet<String>

Elements which will be replaced by spaces (Their children will be processed recursively).

rename_elements: HashMap<String, String>

Elements which will be renamed.

Methods

impl Rules

pub fn new() -> Self

Creates a new rules set.

pub fn allow_comments(self, allow_comments: bool) -> Self

Sets if comments are allowed

pub fn element(self, element: Element) -> Self

Adds a rule for an allowed element

pub fn delete(self, element_name: &str) -> Self

Adds a rule to delete an element

pub fn space(self, element_name: &str) -> Self

Adds a rule to replace an element with space

pub fn rename(self, element_name: &str, to: &str) -> Self

Adds a rule to rename an element

Trait Implementations

impl Default for Rules

fn default() -> Rules

Returns the "default value" for a type.