Skip to main content

CleaningOptions

Struct CleaningOptions 

Source
pub struct CleaningOptions {
    pub tags_to_remove: Vec<String>,
    pub tags_to_strip: Vec<String>,
    pub selectors_to_remove: Vec<String>,
    pub prune_empty: bool,
    pub empty_tags: Vec<String>,
    pub normalize_whitespace: bool,
    pub strip_attributes: bool,
    pub preserved_attributes: Vec<String>,
}
Expand description

Configuration for HTML cleaning operations.

§Example

use html_cleaning::CleaningOptions;

let options = CleaningOptions {
    tags_to_remove: vec!["script".into(), "style".into()],
    prune_empty: true,
    ..Default::default()
};

Fields§

§tags_to_remove: Vec<String>

HTML tags to remove completely (including children).

Example: ["script", "style", "noscript"]

§tags_to_strip: Vec<String>

HTML tags to strip (remove tag, keep children).

Example: ["span", "font"]

§selectors_to_remove: Vec<String>

CSS selectors for elements to remove.

Example: [".advertisement", "#cookie-banner"]

§prune_empty: bool

Remove elements with no text content.

§empty_tags: Vec<String>

Tags considered “empty” for pruning.

Default: ["div", "span", "p", "section", "article"]

§normalize_whitespace: bool

Normalize whitespace in text nodes.

§strip_attributes: bool

Remove all attributes from elements.

§preserved_attributes: Vec<String>

Attributes to preserve when strip_attributes is true.

Example: ["href", "src", "alt"]

Implementations§

Source§

impl CleaningOptions

Source

pub fn builder() -> CleaningOptionsBuilder

Create a new builder for CleaningOptions.

Trait Implementations§

Source§

impl Clone for CleaningOptions

Source§

fn clone(&self) -> CleaningOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CleaningOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CleaningOptions

Source§

fn default() -> CleaningOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.