Struct scraper::html::Html

source · [−]

pub struct Html {
    pub errors: Vec<Cow<'static, str>>,
    pub quirks_mode: QuirksMode,
    pub tree: Tree<Node>,
}

Expand description

An HTML tree.

Parsing does not fail hard. Instead, the quirks_mode is set and errors are added to the errors field. The tree will still be populated as best as possible.

Implements the TreeSink trait from the html5ever crate, which allows HTML to be parsed.

Fields

errors: Vec<Cow<'static, str>>

Parse errors.

quirks_mode: QuirksMode

The quirks mode.

tree: Tree<Node>

The node tree.

Implementations

source

impl Html

source

pub fn new_document() -> Self

Creates an empty HTML document.

source

pub fn new_fragment() -> Self

Creates an empty HTML fragment.

source

pub fn parse_document(document: &str) -> Self

Parses a string of HTML as a document.

This is a convenience method for the following:

use html5ever::driver::{self, ParseOpts};
use scraper::Html;
use tendril::TendrilSink;

let parser = driver::parse_document(Html::new_document(), ParseOpts::default());
let html = parser.one(document);

source

pub fn parse_fragment(fragment: &str) -> Self

Parses a string of HTML as a fragment.

source

pub fn select<'a, 'b>(&'a self, selector: &'b Selector) -> Select<'a, 'b>ⓘNotable traits for Select<'a, 'b>`impl<'a, 'b> Iterator for Select<'a, 'b> type Item = ElementRef<'a>;`

Returns an iterator over elements matching a selector.

source

pub fn root_element(&self) -> ElementRef<'_>

Returns the root <html> element.

Trait Implementations

source

impl Clone for Html

source

fn clone(&self) -> Html

Returns a copy 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 Html

source

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

Formats the value using the given formatter. Read more

source

impl PartialEq<Html> for Html

source

fn eq(&self, other: &Html) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &Html) -> bool

This method tests for !=.

source

impl TreeSink for Html

Note: does not support the <template> element.

type Output = Html

The overall result of parsing. Read more

type Handle = NodeId

Handle is a reference to a DOM node. The tree builder requires that a Handle implements Clone to get another reference to the same node. Read more

source

fn finish(self) -> Self

Consume this sink and return the overall result of parsing. Read more

source

fn parse_error(&mut self, msg: Cow<'static, str>)

Signal a parse error.

source

fn set_quirks_mode(&mut self, mode: QuirksMode)

Set the document’s quirks mode.

source

fn get_document(&mut self) -> Self::Handle

Get a handle to the Document node.

source

fn same_node(&self, x: &Self::Handle, y: &Self::Handle) -> bool

Do two handles refer to the same node?

source

fn elem_name(&self, target: &Self::Handle) -> ExpandedName<'_>

What is the name of this element? Read more

source

fn create_element(
    &mut self,
    name: QualName,
    attrs: Vec<Attribute>,
    _flags: ElementFlags
) -> Self::Handle

Create an element. Read more

source

fn create_comment(&mut self, text: StrTendril) -> Self::Handle

Create a comment node.

source

fn append_doctype_to_document(
    &mut self,
    name: StrTendril,
    public_id: StrTendril,
    system_id: StrTendril
)

Append a DOCTYPE element to the Document node.

source

fn append(&mut self, parent: &Self::Handle, child: NodeOrText<Self::Handle>)

Append a node as the last child of the given node. If this would produce adjacent sibling text nodes, it should concatenate the text instead. Read more

source

fn append_before_sibling(
    &mut self,
    sibling: &Self::Handle,
    new_node: NodeOrText<Self::Handle>
)

Append a node as the sibling immediately before the given node. Read more

source

fn remove_from_parent(&mut self, target: &Self::Handle)

Detach the given node from its parent.

source

fn reparent_children(&mut self, node: &Self::Handle, new_parent: &Self::Handle)

Remove all the children from node and append them to new_parent.

source

fn add_attrs_if_missing(&mut self, target: &Self::Handle, attrs: Vec<Attribute>)

Add each attribute to the given element, if no attribute with that name already exists. The tree builder promises this will never be called with something else than an element. Read more

source

fn get_template_contents(&mut self, target: &Self::Handle) -> Self::Handle

Get a handle to a template’s template contents. The tree builder promises this will never be called with something else than a template element. Read more

source

fn mark_script_already_started(&mut self, _node: &Self::Handle)

Mark a HTML <script> as “already started”.

source

fn create_pi(&mut self, target: StrTendril, data: StrTendril) -> Self::Handle

Create a Processing Instruction node.

source

fn append_based_on_parent_node(
    &mut self,
    element: &Self::Handle,
    prev_element: &Self::Handle,
    child: NodeOrText<Self::Handle>
)

When the insertion point is decided by the existence of a parent node of the element, we consider both possibilities and send the element which will be used if a parent node exists, along with the element to be used if there isn’t one. Read more