Struct DocumentMutator 

pub struct DocumentMutator<'doc> {
    pub doc: &'doc mut BaseDocument,
    /* private fields */
}

Fields

doc: &'doc mut BaseDocument

Document is public as an escape hatch, but users of this API should ideally avoid using it and prefer exposing additional functionality in DocumentMutator.

Implementations

impl DocumentMutator<'_>

pub fn new<'doc>(doc: &'doc mut BaseDocument) -> DocumentMutator<'doc>

pub fn node_has_parent(&self, node_id: NodeId) -> bool

pub fn previous_sibling_id(&self, node_id: NodeId) -> Option<NodeId>

pub fn next_sibling_id(&self, node_id: NodeId) -> Option<NodeId>

pub fn parent_id(&self, node_id: NodeId) -> Option<NodeId>

pub fn last_child_id(&self, node_id: NodeId) -> Option<NodeId>

pub fn child_ids(&self, node_id: NodeId) -> ThinVec<NodeId>

pub fn element_name(&self, node_id: NodeId) -> Option<&QualName>

pub fn node_at_path(&self, start_node_id: NodeId, path: &[u8]) -> NodeId

pub fn create_comment_node(&mut self, contents: &str) -> NodeId

pub fn create_text_node(&mut self, text: &str) -> NodeId

pub fn create_document_fragment(&mut self) -> NodeId

A DocumentFragment: a parentless container that never appears in a box tree and whose children are what gets inserted when it is.

jQuery builds one during initialisation, so without this the library throws before it defines jQuery and every page depending on it loses its scripting. Eight sites in a hundred-site corpus failed that way, and they reported it as jQuery is not defined — the missing method itself says only not a callable function, which names nothing.

pub fn create_html_document(&mut self, title: &str) -> NodeId

A detached HTML document: html > head > title, and body.

This backs document.implementation.createHTMLDocument, which jQuery calls during initialisation to decide whether it can parse markup through a second document. Reading createHTMLDocument off an absent implementation threw before jQuery had assigned itself to window, so every site depending on it reported jQuery is not defined – a global that was never missing.

The node lives in this document’s arena but is attached to nothing, so it never lays out or paints. That is what makes it cheap: no second BaseDocument, no second style engine, no second arena.

pub fn create_document(&mut self, content_type: &'static str) -> NodeId

An empty, detached document in the existing arena.

pub fn adopt_node(&mut self, node_id: NodeId, document_id: NodeId)

Use the native adoption path, including custom element reactions.

pub fn create_element( &mut self, name: QualName, attrs: Vec<Attribute>, ) -> NodeId

pub fn deep_clone_node(&mut self, node_id: NodeId) -> NodeId

pub fn template_contents(&mut self, node_id: NodeId) -> NodeId

The independently owned contents fragment of an HTML template.

pub fn set_node_text(&mut self, node_id: NodeId, value: &str)

pub fn replace_character_data( &mut self, node_id: NodeId, offset: usize, count: usize, value: &str, ) -> Result<(), &'static str>

Replace CharacterData without resetting endpoints outside the replaced span.

pub fn split_text( &mut self, node_id: NodeId, offset: usize, ) -> Result<NodeId, &'static str>

pub fn append_text_to_node( &mut self, node_id: NodeId, text: &str, ) -> Result<(), AppendTextErr>

pub fn add_attrs_if_missing(&mut self, node_id: NodeId, attrs: Vec<Attribute>)

pub fn set_attribute(&mut self, node_id: NodeId, name: QualName, value: &str)

pub fn clear_attribute(&mut self, node_id: NodeId, name: QualName)

pub fn set_style_property(&mut self, node_id: NodeId, name: &str, value: &str)

pub fn remove_style_property(&mut self, node_id: NodeId, name: &str)

pub fn set_sub_document( &mut self, node_id: NodeId, sub_document: Box<dyn Document>, )

pub fn remove_sub_document(&mut self, node_id: NodeId)

pub fn remove_node(&mut self, node_id: NodeId)

pub fn remove_and_drop_node(&mut self, node_id: NodeId) -> Option<Node>

pub fn remove_and_drop_node_with( &mut self, node_id: NodeId, on_drop: &mut dyn FnMut(NodeId), ) -> Option<Node>

Like Self::remove_and_drop_node, but calls on_drop with the id of every dropped node (the node itself and all of its descendants).

pub fn remove_and_drop_all_children(&mut self, node_id: NodeId)

pub fn remove_node_if_unparented(&mut self, node_id: NodeId)

pub fn remove_node_if_unparented_with( &mut self, node_id: NodeId, on_drop: &mut dyn FnMut(NodeId), )

Like Self::remove_node_if_unparented, but calls on_drop with the id of every dropped node (the node itself and all of its descendants).

pub fn append_children(&mut self, parent_id: NodeId, child_ids: &[NodeId])

Remove all of the children from old_parent_id and append them to new_parent_id

pub fn insert_nodes_before( &mut self, anchor_node_id: NodeId, new_node_ids: &[NodeId], )

pub fn insert_nodes_after( &mut self, anchor_node_id: NodeId, new_node_ids: &[NodeId], )

pub fn reparent_children( &mut self, old_parent_id: NodeId, new_parent_id: NodeId, )

pub fn replace_node_with( &mut self, anchor_node_id: NodeId, new_node_ids: &[NodeId], )

impl<'doc> DocumentMutator<'doc>

pub fn flush(&mut self)

pub fn set_inner_html(&mut self, node_id: NodeId, html: &str)

pub fn set_html_unsafe(&mut self, node_id: NodeId, html: &str)

Replace descendants and honor declarative shadow roots.

Trait Implementations

impl Drop for DocumentMutator<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.