Struct html5ever_ext::RcDom

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

The DOM itself; the result of parsing.

Fields

document: Rc<Node>

The Document itself.

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

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(&self, target: &'a Rc<Node>) -> ExpandedName<'a>

What is the name of this element?

fn create_element(
    &mut self,
    name: QualName,
    attrs: Vec<Attribute>,
    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>)

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.

impl Selectable for RcDom

fn find_all_matching_child_nodes_depth_first_excluding_this_one<MatchUser: FnMut(&Rc<Node>) -> bool>(
    &self,
    selector: &OurSelector,
    match_user: &mut MatchUser
) -> bool

Recursively find element nodes that match this selector. Return true from MatchUser to abort early. The result of this function is true if MatchUser aborted early, or false otherwise.

fn find_all_matching_child_nodes_depth_first_including_this_one<MatchUser: FnMut(&Rc<Node>) -> bool>(
    &self,
    selector: &OurSelector,
    match_user: &mut MatchUser
) -> bool

Recursively find element nodes that match this selector. Return true from MatchUser to abort early. The result of this function is true if MatchUser aborted early, or false otherwise.

fn matches(&self, selector: &OurSelector) -> bool

Returns whether this element matches this selector. For the RcDom and &'a RcDom, is currently always false.

impl Minify for RcDom

fn debug_fmt<W: Write>(&self, f: &mut W) -> Result

Identical to impl Debug's fmt() method, except we can't impl Debug for a trait and struct we don't own in this crate.

fn minify_to_writer<W: Write>(
    &self,
    html_head_and_body_tags_are_optional: bool,
    writer: W
) -> Result<()>

Minifies and serializes an instance of an HTML DOM to a writer. If creating AMP pages, set html_head_and_body_tags_are_optional to false. If you need to serialize multiple RcDom or Node objects to the same writer, or need more control, consider using UltraMinifyingHtmlSerializer.

fn debug_string(&self) -> String

A debug string representing this node and any children.

fn minify_to_file_path<P: AsRef<Path>>(
    &self,
    html_head_and_body_tags_are_optional: bool,
    html_file_path: P
) -> Result<(), HtmlError>

Minifies and serializes an instance of an HTML DOM to file. If creating AMP pages, set html_head_and_body_tags_are_optional to false. If you need to serialize multiple RcDom or Node objects to the same writer, or need more control, consider using UltraMinifyingHtmlSerializer.

fn minify_to_string(&self, html_head_and_body_tags_are_optional: bool) -> String

Minifies and serializes an instance of an HTML DOM to String. If creating AMP pages, set html_head_and_body_tags_are_optional to false. If you need to serialize multiple RcDom or Node objects to the same writer, or need more control, consider using UltraMinifyingHtmlSerializer.

Important traits for Vec<u8>

impl Write for Vec<u8>

fn minify_to_bytes(&self, html_head_and_body_tags_are_optional: bool) -> Vec<u8>

Minifies and serializes an instance of an HTML DOM to a vector of bytes. If creating AMP pages, set html_head_and_body_tags_are_optional to false. If you need to serialize multiple RcDom or Node objects to the same writer, or need more control, consider using UltraMinifyingHtmlSerializer.

impl QualNameExt for RcDom

fn is_unprefixed_and_html_namespace_or_none(&self) -> bool

Is this name effectively local?

fn is_only_local(&self, local_name: &LocalName) -> bool

Is this qualified name this local-only name (no prefix, no namespace)

fn is_only_local_of(&self, local_names: &[LocalName]) -> bool

Is this qualified name on these local-only names (no prefix, no namespace)

fn can_have_children(&self) -> bool

Can this element have children?

fn text_content_should_be_escaped(&self) -> bool

Should an immediate child text node have <, > and & characters escaped? In modern HTML 5, the only common nodes which don't need this are <script> and <style>. In this case, the immediate child text node's content should not contain, say, </script> as this will cause a parse error.

fn can_collapse_whitespace(&self) -> bool

Can this element's descendant text nodes have leading, trailing and interstitial whitespace collapsed?

impl RcDomExt for RcDom

fn from_file_path_verified_and_stripped_of_comments_and_processing_instructions_and_with_a_sane_doc_type<P: AsRef<Path>>(
    html_document_file_path: P
) -> Result<Self, HtmlError>

Creates an instance of an HTML DOM from a file path which is verified, stripped and with a sane DocType.

fn from_file_path<P: AsRef<Path>>(
    html_document_file_path: P
) -> Result<Self, HtmlError>

Creates an instance of an HTML DOM from a file path

fn from_bytes_verified_and_stripped_of_comments_and_processing_instructions_and_with_a_sane_doc_type<P: AsRef<Path>>(
    bytes: &[u8],
    context: P
) -> Result<Self, HtmlError>

Creates an instance of an HTML DOM from bytes which is verified, stripped and with a sane DocType.

fn from_bytes(bytes: &[u8]) -> Self

Creates an instance of an HTML DOM from bytes

fn verify(&self, context: &Path) -> Result<(), HtmlError>

Verify that this HTML DOM is valid.

fn recursively_strip_nodes_of_comments_and_processing_instructions_and_create_sane_doc_type(
    &self,
    context: &Path
) -> Result<(), HtmlError>

Remove all comments and processing instructions and make the DOCTYPE a simple 'html' (for HTML 5).

fn create_html5_document(&mut self, unattached_node: UnattachedNode) -> Rc<Node>

Adds this node preceded by a HTML5 DOCTYPE. Panics if the unattached_node is not called 'html'.

fn attach_to_document_node(
    &mut self,
    unattached_node: UnattachedNode
) -> Rc<Node>

Attaches this node as a child of the document, ie as a root element node

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

Moves a node's children to the document node

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

Appends a new element node to the document node

fn append_new_element_to_document_node(
    &mut self,
    qualified_name: QualName,
    attributes: Vec<Attribute>
) -> Rc<Node>

Appends a new element node to the document node

fn append_new_comment_to_document_node(&mut self, comment: &str)

Appends a new comment node to the document node

fn append_new_processing_instruction_to_document_node(
    &mut self,
    target: &str,
    data: &str
)

Appends a new processing instruction node to the document node

fn append_text_to_document_node(&mut self, text: &str)

Appends a text node to the document node

fn move_node_children_to_parent_node(
    &mut self,
    parent_node: &Rc<Node>,
    node: &Rc<Node>
)

Moves a node's children to another parent node

fn move_node_to_parent_node(&mut self, parent_node: &Rc<Node>, node: &Rc<Node>)

Moves an existing element node to a parent node

fn move_node_before_sibling_node(
    &mut self,
    sibling_node: &Rc<Node>,
    node: &Rc<Node>
)

Moves an existing element before a sibling node

fn append_new_element_to_parent_node(
    &mut self,
    parent_node: &Rc<Node>,
    qualified_name: QualName,
    attributes: Vec<Attribute>
) -> Rc<Node>

Appends a new element node to a parent node

fn append_new_element_before_sibling_node(
    &mut self,
    sibling_node: &Rc<Node>,
    qualified_name: QualName,
    attributes: Vec<Attribute>
) -> Rc<Node>

Appends a new element before a sibling node

fn append_new_comment_to_parent_node(
    &mut self,
    parent_node: &Rc<Node>,
    comment: &str
)

Appends a new comment node to a parent node

fn append_new_comment_before_sibling_node(
    &mut self,
    sibling_node: &Rc<Node>,
    comment: &str
)

Appends a new comment before a sibling node

fn append_new_processing_instruction_to_parent_node(
    &mut self,
    parent_node: &Rc<Node>,
    target: &str,
    data: &str
)

Appends a new processing instruction node to a parent node

fn append_new_processing_instruction_before_sibling_node(
    &mut self,
    sibling_node: &Rc<Node>,
    target: &str,
    data: &str
)

Appends a new processing instruction before a sibling node

fn append_text_to_parent_node(&mut self, parent_node: &Rc<Node>, text: &str)

Appends a text node to a parent node

fn append_text_before_sibling_node(
    &mut self,
    sibling_node: &Rc<Node>,
    text: &str
)

Appends a text node before a sibling node