Struct DomTreeSink 

pub struct DomTreeSink { /* private fields */ }

TreeSink implementation that builds a DOM.

Uses UnsafeCell because html5ever’s TreeSink trait takes &self but tree building inherently requires mutation.

Safety

DomTreeSink is not Sync. It is owned by a single parsing thread for the lifetime of the parse. html5ever calls TreeSink methods serially from that thread — never concurrently, never reentrantly. References handed out by helpers are dropped before the next callback runs.

Implementations

impl DomTreeSink

pub fn new() -> Self

Trait Implementations

impl Default for DomTreeSink

fn default() -> Self

Returns the “default value” for a type.

impl TreeSink for DomTreeSink

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.

type Output = Dom

The overall result of parsing.

type ElemName<'a> = ExpandedName<'a>

fn finish(self) -> Self::Output

Consume this sink and return the overall result of parsing.

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

Signal a parse error.

fn get_document(&self) -> NodeId

Get a handle to the Document node.

fn elem_name<'a>(&'a self, target: &'a NodeId) -> ExpandedName<'a>

What is the name of this element?

fn create_element( &self, name: H5QualName, attrs: Vec<H5Attribute>, _flags: ElementFlags, ) -> NodeId

Create an element.

fn create_comment(&self, text: StrTendril) -> NodeId

Create a comment node.

fn create_pi(&self, target: StrTendril, data: StrTendril) -> NodeId

Create a Processing Instruction node.

fn append(&self, parent: &NodeId, child: NodeOrText<NodeId>)

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.

fn append_based_on_parent_node( &self, element: &NodeId, prev_element: &NodeId, child: NodeOrText<NodeId>, )

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.

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

Append a DOCTYPE element to the Document node.

fn get_template_contents(&self, target: &NodeId) -> NodeId

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.

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

Do two handles refer to the same node?

fn set_quirks_mode(&self, mode: QuirksMode)

Set the document’s quirks mode.

fn append_before_sibling(&self, sibling: &NodeId, child: NodeOrText<NodeId>)

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

fn add_attrs_if_missing(&self, target: &NodeId, attrs: Vec<H5Attribute>)

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.

fn remove_from_parent(&self, target: &NodeId)

Detach the given node from its parent.

fn reparent_children(&self, node: &NodeId, new_parent: &NodeId)

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

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

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

fn pop(&self, _node: &Self::Handle)

Indicate that a node was popped off the stack of open elements.

fn associate_with_form( &self, _target: &Self::Handle, _form: &Self::Handle, _nodes: (&Self::Handle, Option<&Self::Handle>), )

Associate the given form-associatable element with the form element

fn is_mathml_annotation_xml_integration_point( &self, _handle: &Self::Handle, ) -> bool

Returns true if the adjusted current node is an HTML integration point and the token is a start tag.

fn set_current_line(&self, _line_number: u64)

Called whenever the line number changes.

fn allow_declarative_shadow_roots( &self, _intended_parent: &Self::Handle, ) -> bool

fn attach_declarative_shadow( &self, _location: &Self::Handle, _template: &Self::Handle, _attrs: &[Attribute], ) -> bool

Attempt to attach a declarative shadow root at the given location.

fn maybe_clone_an_option_into_selectedcontent(&self, option: &Self::Handle)

Implements maybe clone an option into selectedcontent.