Struct RemoveComments 

pub struct RemoveComments {
    pub preserve_patterns: Option<Vec<PreservePattern>>,
}

Removes XML comments from the document.

By default this job ignores comments starting with <!--! which is often used for legal information, such as copyright, licensing, or attribution.

Correctness

This job should never visually change the document.

Scripts which target comments, or conditional comments such as <!--[if IE 8]> may be affected.

Errors

Never.

If this job produces an error or panic, please raise an issue

Fields

preserve_patterns: Option<Vec<PreservePattern>>

A list of regex patters to match against comments, where matching comments will not be removed from the document.

Trait Implementations

impl Clone for RemoveComments

fn clone(&self) -> RemoveComments

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoveComments

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

Formats the value using the given formatter.

impl Default for RemoveComments

fn default() -> RemoveComments

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RemoveComments

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RemoveComments

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'input, 'arena> Visitor<'input, 'arena> for RemoveComments

type Error = JobsError<'input>

The type of errors which may be produced by the visitor

fn comment(&self, comment: &Node<'input, 'arena>) -> Result<(), Self::Error>

Visits a comment

fn document( &self, document: &Element<'input, 'arena>, context: &Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Visits the document

fn exit_document( &self, document: &Element<'input, 'arena>, context: &Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Exits the document

fn element( &self, element: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Visits a element

fn exit_element( &self, element: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Exits a element

fn doctype( &self, doctype: &'arena Node<'input, 'arena>, ) -> Result<(), Self::Error>

Visits the doctype

fn style(&self, style: &'arena Node<'input, 'arena>) -> Result<(), Self::Error>

Visits the text of a style element

fn text_or_cdata( &self, node: &'arena Node<'input, 'arena>, ) -> Result<(), Self::Error>

Visits a text or cdata node

fn processing_instruction( &self, processing_instruction: &'arena Node<'input, 'arena>, context: &Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Visits a processing instruction

fn prepare( &self, document: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<PrepareOutcome, Self::Error>

After analysing the document, determines whether any extra features such as style parsing or ignoring the tree is needed

fn start( &self, root: &'arena Node<'input, 'arena>, allocator: Allocator<'input, 'arena>, ) -> Result<PrepareOutcome, Self::Error>

Creates context for root and visits it

fn start_with_path( &self, root: &'arena Node<'input, 'arena>, allocator: Allocator<'input, 'arena>, path: Option<PathBuf>, ) -> Result<PrepareOutcome, Self::Error>

Starts visiting the document, adding the path to the visitor’s context

fn start_with_info( &self, root: &Element<'input, 'arena>, info: &Info<'input, 'arena>, flags: Option<ContextFlags>, ) -> Result<PrepareOutcome, Self::Error>

Creates context for root using the provided information and visits it

fn start_with_context( &self, root: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<PrepareOutcome, Self::Error>

Starts visiting the document, using an already existing visitor’s context

fn visit( &self, element: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Visits an element and it’s children

fn visit_children( &self, parent: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Visits the children of an element