Struct extrablatt::clean::CommonCleaner

pub struct CommonCleaner<P> where
    P: Fn(Node<'_>) -> bool,  {
    pub bad_node_names: HashSet<Cow<'static, str>>,
    pub is_good_node: P,
}

A DocumentCleaner that uses names to detect tags to ignore by default and a predicate to decide whether a tag should be ignore

Fields

bad_node_names: HashSet<Cow<'static, str>>

html tag names that are ignore by default

is_good_node: P

Predicate to decide whether a node can hold valid textual content

Implementations

impl<P> CommonCleaner<P> where
    P: Fn(Node<'_>) -> bool, 

pub fn new(is_good_node: P) -> Self

Create a new Cleaner that ignores BAD_TAG_NAMES nodes by default and decides whether to extract text from a node based on the is_good_node predicate

pub fn with_names<T, I>(is_good_node: P, bad_names: T) -> Self where
    T: IntoIterator<Item = I>,
    I: Into<Cow<'static, str>>, 

Create a new Cleaner that ignores bad_names nodes by default and decides whether to extract text from a node based on the is_good_node predicate

Trait Implementations

impl<P: Debug> Debug for CommonCleaner<P> where
    P: Fn(Node<'_>) -> bool, 

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

Formats the value using the given formatter.

impl Default for CommonCleaner<fn's(_: Node<'s>) -> bool>

fn default() -> Self

Returns the "default value" for a type.

impl<P> DocumentCleaner for CommonCleaner<P> where
    P: Fn(Node<'_>) -> bool, 

fn is_good_node(&self, node: Node<'_>) -> bool

Whether the node should be considered

fn is_bad_node_name(&self, node: Node<'_>) -> bool

Whether the node's should be ignored based on its name

fn clean_node_text(&self, node: Node<'_>) -> String

Extract all textual content from the node, but ignore those nodes, that do not contain parts of the article.

fn iter_clean_nodes<'a>(&'a self, node: Node<'a>) -> CleanNodeIter<'a, Self> where
    Self: Sized, 

Create an iterator that yields every node that this cleaner considers good