Struct Html

Help

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> ⓘ

Returns an iterator over elements matching a selector.

Source

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

Returns the root <html> element.

Source

pub fn html(&self) -> String

Serialize entire document into HTML.

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 for Html

Source §

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Source §

impl Serialize for Html

Source §

fn serialize<S: Serializer>( &self, serializer: &mut S, traversal_scope: TraversalScope, ) -> Result<(), Error>

Take the serializer and call its methods to serialize this type. The type will dictate which methods are called and with what parameters.

Source §

impl TreeSink for Html

Note: does not support the <template> element.

Source §

type Output = Html

The overall result of parsing. Read more

Source §

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.

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.

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.

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.

Source §