Struct html2md::RcDom

pub struct RcDom {
    pub document: Rc<Node>,
    pub errors: Vec<Cow<'static, str>, Global>,
    pub quirks_mode: QuirksMode,
}

The DOM itself; the result of parsing.

Fields

document: Rc<Node>

The Document itself.

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

Errors that occurred during parsing.

quirks_mode: QuirksMode

The document’s quirks mode.

Trait Implementations

impl Default for RcDom

fn default() -> RcDom

Returns the “default value” for a type.

impl TreeSink for RcDom

type Output = RcDom

The overall result of parsing.

fn finish(self) -> RcDom

Consume this sink and return the overall result of parsing.

type Handle = Rc<Node>

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, msg: Cow<'static, str>)

Signal a parse error.

fn get_document(&mut self) -> Rc<Node>

Get a handle to the Document node.

fn get_template_contents(&mut self, target: &Rc<Node>) -> Rc<Node>

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 set_quirks_mode(&mut self, mode: QuirksMode)

Set the document’s quirks mode.

fn same_node(&self, x: &Rc<Node>, y: &Rc<Node>) -> bool

Do two handles refer to the same node?

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

What is the name of this element?

fn create_element(
    &mut self,
    name: QualName,
    attrs: Vec<Attribute, Global>,
    flags: ElementFlags
) -> Rc<Node>

Create an element.

fn create_comment(&mut self, text: Tendril<UTF8, NonAtomic>) -> Rc<Node>

Create a comment node.

fn create_pi(
    &mut self,
    target: Tendril<UTF8, NonAtomic>,
    data: Tendril<UTF8, NonAtomic>
) -> Rc<Node>

Create a Processing Instruction node.

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

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: &Rc<Node>,
    child: NodeOrText<Rc<Node>>
)

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

fn append_based_on_parent_node(
    &mut self,
    element: &<RcDom as TreeSink>::Handle,
    prev_element: &<RcDom as TreeSink>::Handle,
    child: NodeOrText<<RcDom as TreeSink>::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.

fn append_doctype_to_document(
    &mut self,
    name: Tendril<UTF8, NonAtomic>,
    public_id: Tendril<UTF8, NonAtomic>,
    system_id: Tendril<UTF8, NonAtomic>
)

Append a DOCTYPE element to the Document node.

fn add_attrs_if_missing(
    &mut self,
    target: &Rc<Node>,
    attrs: Vec<Attribute, Global>
)

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: &Rc<Node>)

Detach the given node from its parent.

fn reparent_children(&mut self, node: &Rc<Node>, new_parent: &Rc<Node>)

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

fn is_mathml_annotation_xml_integration_point(&self, target: &Rc<Node>) -> bool

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

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

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

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