Struct struckdown::processors::HtmlSanitizer

pub struct HtmlSanitizer {
    pub link_rel: Option<String>,
    pub url_schemes: HashSet<String>,
    pub allow_class: bool,
    pub allow_style: bool,
    pub allow_comments: bool,
}

Automatically add anchors to all headers when missing.

When applied this wraps the stream in a HtmlSanitizerIter.

Fields

link_rel: Option<String>

Configures link rel to be added to all links.

url_schemes: HashSet<String>

Permitted URL schems.

allow_class: bool

If configured the class attribute is permitted without filtering.

allow_style: bool

If configured the style attribute is permitted without filtering.

allow_comments: bool

If set to false then comments are removed.

Trait Implementations

impl Clone for HtmlSanitizer

pub fn clone(&self) -> HtmlSanitizer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HtmlSanitizer

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

Formats the value using the given formatter.

impl Default for HtmlSanitizer

pub fn default() -> HtmlSanitizer

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for HtmlSanitizer where
    HtmlSanitizer: Default, 

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Processor for HtmlSanitizer

pub fn apply<'data>(
    self: Box<Self>,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

Applies the processor to an event stream.

pub fn apply_ref<'data, 'options: 'data>(
    &'options self,
    iter: Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>
) -> Box<dyn Iterator<Item = AnnotatedEvent<'data>> + 'data>

Applies the processor to an event stream.

impl Serialize for HtmlSanitizer

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.