Struct kuchiki::Sink

pub struct Sink { /* fields omitted */ }

Receives new tree nodes during parsing.

Trait Implementations

impl TreeSink for Sink

type Output = NodeRef

The overall result of parsing.

fn finish(self) -> NodeRef

Consume this sink and return the overall result of parsing.

type Handle = NodeRef

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.

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

Signal a parse error.

fn get_document(&mut self) -> NodeRef

Get a handle to the Document node.

fn set_quirks_mode(&mut self, mode: QuirksMode)

Set the document's quirks mode.

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

Do two handles refer to the same node?

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

What is the name of this element?

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

Create an element.

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

Create a comment node.

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

Create a Processing Instruction node.

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

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_before_sibling(
    &mut self,
    sibling: &NodeRef,
    child: NodeOrText<NodeRef>
)

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

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

Append a DOCTYPE element to the Document node.

fn add_attrs_if_missing(&mut self, target: &NodeRef, 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.

fn remove_from_parent(&mut self, target: &NodeRef)

Detach the given node from its parent.

fn reparent_children(&mut self, node: &NodeRef, new_parent: &NodeRef)

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

fn mark_script_already_started(&mut self, _node: &NodeRef)

Mark a HTML <script> as "already started".

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

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 append_based_on_parent_node(
    &mut self,
    element: &NodeRef,
    prev_element: &NodeRef,
    child: NodeOrText<NodeRef>
)

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 pop(&mut self, _node: &Self::Handle)

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

fn associate_with_form(
    &mut 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(&mut self, _line_number: u64)

Called whenever the line number changes.

fn complete_script(&mut self, _node: &Self::Handle) -> NextParserState

Indicate that a script element is complete.