Struct script::dom::node::Node

#[repr(C)]
pub struct Node {

    eventtarget: EventTarget,
    parent_node: MutNullableDom<Node>,
    first_child: MutNullableDom<Node>,
    last_child: MutNullableDom<Node>,
    next_sibling: MutNullableDom<Node>,
    prev_sibling: MutNullableDom<Node>,
    owner_doc: MutNullableDom<Document>,
    rare_data: DomRefCell<Option<Box<NodeRareData>>>,
    child_list: MutNullableDom<NodeList>,
    children_count: Cell<u32>,
    flags: Cell<NodeFlags>,
    inclusive_descendants_version: Cell<u64>,
    ranges: WeakRangeVec,
    style_and_layout_data: DomRefCell<Option<Box<StyleAndOpaqueLayoutData>>>,
}

An HTML node.

Fields

eventtarget: EventTarget

The JavaScript reflector for this node.

parent_node: MutNullableDom<Node>

The parent of this node.

first_child: MutNullableDom<Node>

The first child of this node.

last_child: MutNullableDom<Node>

The last child of this node.

next_sibling: MutNullableDom<Node>

The next sibling of this node.

prev_sibling: MutNullableDom<Node>

The previous sibling of this node.

owner_doc: MutNullableDom<Document>

The document that this node belongs to.

rare_data: DomRefCell<Option<Box<NodeRareData>>>

Rare node data.

child_list: MutNullableDom<NodeList>

The live list of children return by .childNodes.

children_count: Cell<u32>

The live count of children of this node.

flags: Cell<NodeFlags>

A bitfield of flags for node items.

inclusive_descendants_version: Cell<u64>

The maximum version of any inclusive descendant of this node.

ranges: WeakRangeVec

A vector of weak references to Range instances of which the start or end containers are this node. No range should ever be found twice in this vector, even if both the start and end containers are this node.

style_and_layout_data: DomRefCell<Option<Box<StyleAndOpaqueLayoutData>>>

Style+Layout information.

Implementations

impl Node

fn add_child(&self, new_child: &Node, before: Option<&Node>)

Adds a new child to the end of this node’s list of children.

Fails unless new_child is disconnected from the tree.

pub fn clean_up_layout_data(&self)

pub fn complete_remove_subtree(root: &Node, context: &UnbindContext<'_>)

Clean up flags and unbind from tree.

fn remove_child(&self, child: &Node, cached_index: Option<u32>)

Removes the given child from this node’s list of children.

Fails unless child is a child of this node.

pub fn to_untrusted_node_address(&self) -> UntrustedNodeAddress

pub fn to_opaque(&self) -> OpaqueNode

pub fn as_custom_element(&self) -> Option<Root<Dom<Element>>>

pub fn fire_synthetic_mouse_event_not_trusted(&self, name: DOMString)

pub fn parent_directionality(&self) -> String

impl Node

fn rare_data(&self) -> Ref<'_, Option<Box<NodeRareData>>>

fn rare_data_mut(&self) -> RefMut<'_, Option<Box<NodeRareData>>>

fn ensure_rare_data(&self) -> RefMut<'_, Box<NodeRareData>>

pub fn is_before(&self, other: &Node) -> bool

Returns true if this node is before other in the same connected DOM tree.

pub fn registered_mutation_observers_mut(
    &self
) -> RefMut<'_, Vec<RegisteredObserver>>

Return all registered mutation observers for this node. Lazily initialize the raredata if it does not exist.

pub fn registered_mutation_observers(
    &self
) -> Option<Ref<'_, Vec<RegisteredObserver>>>

pub fn add_mutation_observer(&self, observer: RegisteredObserver)

Add a new mutation observer for a given node.

pub fn remove_mutation_observer(&self, observer: &MutationObserver)

Removes the mutation observer for a given node.

pub fn dump(&self)

Dumps the subtree rooted at this node, for debugging.

pub fn dump_indent(&self, indent: u32)

Dumps the node tree, for debugging, with indentation.

pub fn debug_str(&self) -> String

Returns a string that describes this node.

pub fn is_in_doc(&self) -> bool

pub fn is_in_shadow_tree(&self) -> bool

pub fn has_weird_parser_insertion_mode(&self) -> bool

pub fn set_weird_parser_insertion_mode(&self)

pub fn is_connected(&self) -> bool

pub fn type_id(&self) -> NodeTypeId

Returns the type ID of this node.

pub fn len(&self) -> u32

pub fn index(&self) -> u32

pub fn has_parent(&self) -> bool

Returns true if this node has a parent.

pub fn children_count(&self) -> u32

pub fn ranges(&self) -> &WeakRangeVec

pub fn is_doctype(&self) -> bool

pub fn get_flag(&self, flag: NodeFlags) -> bool

pub fn set_flag(&self, flag: NodeFlags, value: bool)

pub fn note_dirty_descendants(&self)

pub fn has_dirty_descendants(&self) -> bool

pub fn rev_version(&self)

pub fn dirty(&self, damage: NodeDamage)

pub fn inclusive_descendants_version(&self) -> u64

The maximum version number of this node’s descendants, including itself

pub fn traverse_preorder(
    &self,
    shadow_including: ShadowIncluding
) -> TreeIterator

Iterates over this node and all its descendants, in preorder.

pub fn inclusively_following_siblings(
    &self
) -> impl Iterator<Item = Root<Dom<Node>>>

pub fn inclusively_preceding_siblings(
    &self
) -> impl Iterator<Item = Root<Dom<Node>>>

pub fn common_ancestor(
    &self,
    other: &Node,
    shadow_including: ShadowIncluding
) -> Option<Root<Dom<Node>>>

pub fn is_inclusive_ancestor_of(&self, parent: &Node) -> bool

pub fn is_ancestor_of(&self, parent: &Node) -> bool

fn is_shadow_including_inclusive_ancestor_of(&self, node: &Node) -> bool

pub fn following_siblings(&self) -> impl Iterator<Item = Root<Dom<Node>>>

pub fn preceding_siblings(&self) -> impl Iterator<Item = Root<Dom<Node>>>

pub fn following_nodes(&self, root: &Node) -> FollowingNodeIterator

pub fn preceding_nodes(&self, root: &Node) -> PrecedingNodeIterator

pub fn descending_last_children(&self) -> impl Iterator<Item = Root<Dom<Node>>>

pub fn is_parent_of(&self, child: &Node) -> bool

pub fn to_trusted_node_address(&self) -> TrustedNodeAddress

pub fn bounding_content_box(&self) -> Option<Rect<Au>>

Returns the rendered bounding content box if the element is rendered, and none otherwise.

pub fn bounding_content_box_or_zero(&self) -> Rect<Au>

pub fn content_boxes(&self) -> Vec<Rect<Au>>

pub fn client_rect(&self) -> Rect<i32>

pub fn scroll_area(&self) -> Rect<i32>

pub fn scroll_offset(&self) -> Vector2D<f32>

pub fn before(&self, nodes: Vec<NodeOrString>) -> Result<(), Error>

pub fn after(&self, nodes: Vec<NodeOrString>) -> Result<(), Error>

pub fn replace_with(&self, nodes: Vec<NodeOrString>) -> Result<(), Error>

pub fn prepend(&self, nodes: Vec<NodeOrString>) -> Result<(), Error>

pub fn append(&self, nodes: Vec<NodeOrString>) -> Result<(), Error>

pub fn replace_children(&self, nodes: Vec<NodeOrString>) -> Result<(), Error>

pub fn query_selector(
    &self,
    selectors: DOMString
) -> Result<Option<Root<Dom<Element>>>, Error>

pub fn query_selector_iter(
    &self,
    selectors: DOMString
) -> Result<QuerySelectorIterator, Error>

https://dom.spec.whatwg.org/#scope-match-a-selectors-string Get an iterator over all nodes which match a set of selectors Be careful not to do anything which may manipulate the DOM tree whilst iterating, otherwise the iterator may be invalidated.

pub fn query_selector_all(
    &self,
    selectors: DOMString
) -> Result<Root<Dom<NodeList>>, Error>

pub fn ancestors(&self) -> impl Iterator<Item = Root<Dom<Node>>>

pub fn inclusive_ancestors(
    &self,
    shadow_including: ShadowIncluding
) -> impl Iterator<Item = Root<Dom<Node>>>

https://dom.spec.whatwg.org/#concept-shadow-including-inclusive-ancestor

pub fn owner_doc(&self) -> Root<Dom<Document>>

pub fn set_owner_doc(&self, document: &Document)

pub fn containing_shadow_root(&self) -> Option<Root<Dom<ShadowRoot>>>

pub fn set_containing_shadow_root(&self, shadow_root: Option<&ShadowRoot>)

pub fn is_in_html_doc(&self) -> bool

pub fn is_connected_with_browsing_context(&self) -> bool

pub fn children(&self) -> impl Iterator<Item = Root<Dom<Node>>>

pub fn rev_children(&self) -> impl Iterator<Item = Root<Dom<Node>>>

pub fn child_elements(&self) -> impl Iterator<Item = Root<Dom<Element>>>

pub fn remove_self(&self)

pub fn unique_id(&self) -> String

pub fn summarize(&self) -> NodeInfo

pub fn insert_cell_or_row<F, G, I>(
    &self,
    index: i32,
    get_items: F,
    new_child: G
) -> Result<Root<Dom<HTMLElement>>, Error> where
    F: Fn() -> Root<Dom<HTMLCollection>>,
    G: Fn() -> Root<Dom<I>>,
    I: DerivedFrom<Node> + DerivedFrom<HTMLElement> + DomObject, 

Used by HTMLTableSectionElement::InsertRow and HTMLTableRowElement::InsertCell

pub fn delete_cell_or_row<F, G>(
    &self,
    index: i32,
    get_items: F,
    is_delete_type: G
) -> Result<(), Error> where
    F: Fn() -> Root<Dom<HTMLCollection>>,
    G: Fn(&Element) -> bool, 

Used by HTMLTableSectionElement::DeleteRow and HTMLTableRowElement::DeleteCell

pub fn get_stylesheet(&self) -> Option<Arc<Stylesheet>>

pub fn get_cssom_stylesheet(&self) -> Option<Root<Dom<CSSStyleSheet>>>

pub fn retarget(&self, b: &Node) -> Root<Dom<Node>>

https://dom.spec.whatwg.org/#retarget

pub fn is_document_named_item(&self, name: &Atom) -> bool

pub fn is_styled(&self) -> bool

pub fn is_display_none(&self) -> bool

pub fn style(&self) -> Option<Arc<ComputedValues>>

impl Node

pub fn reflect_node<N>(node: Box<N>, document: &Document) -> Root<Dom<N>> where
    N: DerivedFrom<Node> + DomObject + DomObjectWrap, 

pub fn new_inherited(doc: &Document) -> Node

pub fn new_document_node() -> Node

fn new_(flags: NodeFlags, doc: Option<&Document>) -> Node

pub fn adopt(node: &Node, document: &Document)

pub fn ensure_pre_insertion_validity(
    node: &Node,
    parent: &Node,
    child: Option<&Node>
) -> Result<(), Error>

pub fn pre_insert(
    node: &Node,
    parent: &Node,
    child: Option<&Node>
) -> Result<Root<Dom<Node>>, Error>

fn insert(
    node: &Node,
    parent: &Node,
    child: Option<&Node>,
    suppress_observers: SuppressObserver
)

pub fn replace_all(node: Option<&Node>, parent: &Node)

pub fn string_replace_all(string: DOMString, parent: &Node)

fn pre_remove(child: &Node, parent: &Node) -> Result<Root<Dom<Node>>, Error>

fn remove(node: &Node, parent: &Node, suppress_observers: SuppressObserver)

pub fn clone(
    node: &Node,
    maybe_doc: Option<&Document>,
    clone_children: CloneChildrenFlag
) -> Root<Dom<Node>>

pub fn child_text_content(&self) -> DOMString

https://html.spec.whatwg.org/multipage/#child-text-content

pub fn descendant_text_content(&self) -> DOMString

https://html.spec.whatwg.org/multipage/#descendant-text-content

pub fn collect_text_contents<T: Iterator<Item = Root<Dom<Node>>>>(
    iterator: T
) -> DOMString

pub fn namespace_to_string(namespace: Namespace) -> Option<DOMString>

pub fn locate_namespace(node: &Node, prefix: Option<DOMString>) -> Namespace

Trait Implementations

impl Castable for Node

fn is<T>(&self) -> bool where
    T: DerivedFrom<Self>, 

Check whether a DOM object implements one of its deriving interfaces.

fn upcast<T>(&self) -> &T where
    T: Castable,
    Self: DerivedFrom<T>, 

Cast a DOM object upwards to one of the interfaces it derives from.

fn downcast<T>(&self) -> Option<&T> where
    T: DerivedFrom<Self>, 

Cast a DOM object downwards to one of the interfaces it might implement.

impl DomObject for Node

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>> where
    Self: Sized, 

Returns the global scope of the realm that the DomObject was created in.

impl HasParent for Node

fn as_parent(&self) -> &EventTarget

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = EventTarget

impl IDLInterface for Node

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl JSTraceable for Node

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl MallocSizeOf for Node

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MutDomObject for Node

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl NodeMethods for Node

fn NodeType(&self) -> u16

fn NodeName(&self) -> DOMString

fn BaseURI(&self) -> USVString

fn IsConnected(&self) -> bool

fn GetOwnerDocument(&self) -> Option<Root<Dom<Document>>>

fn GetRootNode(&self, options: &GetRootNodeOptions) -> Root<Dom<Node>>

fn GetParentNode(&self) -> Option<Root<Dom<Node>>>

fn GetParentElement(&self) -> Option<Root<Dom<Element>>>

fn HasChildNodes(&self) -> bool

fn ChildNodes(&self) -> Root<Dom<NodeList>>

fn GetFirstChild(&self) -> Option<Root<Dom<Node>>>

fn GetLastChild(&self) -> Option<Root<Dom<Node>>>

fn GetPreviousSibling(&self) -> Option<Root<Dom<Node>>>

fn GetNextSibling(&self) -> Option<Root<Dom<Node>>>

fn GetNodeValue(&self) -> Option<DOMString>

fn SetNodeValue(&self, val: Option<DOMString>)

fn GetTextContent(&self) -> Option<DOMString>

fn SetTextContent(&self, value: Option<DOMString>)

fn InsertBefore(
    &self,
    node: &Node,
    child: Option<&Node>
) -> Result<Root<Dom<Node>>, Error>

fn AppendChild(&self, node: &Node) -> Result<Root<Dom<Node>>, Error>

fn ReplaceChild(
    &self,
    node: &Node,
    child: &Node
) -> Result<Root<Dom<Node>>, Error>

fn RemoveChild(&self, node: &Node) -> Result<Root<Dom<Node>>, Error>

fn Normalize(&self)

fn CloneNode(&self, deep: bool) -> Result<Root<Dom<Node>>, Error>

fn IsEqualNode(&self, maybe_node: Option<&Node>) -> bool

fn IsSameNode(&self, other_node: Option<&Node>) -> bool

fn CompareDocumentPosition(&self, other: &Node) -> u16

fn Contains(&self, maybe_other: Option<&Node>) -> bool

fn LookupPrefix(&self, namespace: Option<DOMString>) -> Option<DOMString>

fn LookupNamespaceURI(&self, prefix: Option<DOMString>) -> Option<DOMString>

fn IsDefaultNamespace(&self, namespace: Option<DOMString>) -> bool

impl PartialEq<Node> for Node

fn eq(&self, other: &Node) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> Serialize for &'a Node

fn serialize<S: Serializer>(
    &self,
    serializer: &mut S,
    traversal_scope: TraversalScope
) -> Result<()>

Take the serializer and call its methods to serialize this type. The type will dictate which methods are called and with what parameters.

impl ToJSValConvertible for Node

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

impl VirtualMethods for Node

fn super_type(&self) -> Option<&dyn VirtualMethods>

Returns self as the superclass of the implementation for this trait, if any.

fn children_changed(&self, mutation: &ChildrenMutation<'_>)

Called on the parent when its children are changed.

fn unbind_from_tree(&self, context: &UnbindContext<'_>)

Called when a Node is removed from a tree, where ‘tree_connected’ indicates whether the tree is part of a Document. Implements removing steps: https://dom.spec.whatwg.org/#concept-node-remove-ext

fn attribute_mutated(&self, attr: &Attr, mutation: AttributeMutation<'_>)

Called when attributes of a node are mutated. https://dom.spec.whatwg.org/#attribute-is-set https://dom.spec.whatwg.org/#attribute-is-removed

fn attribute_affects_presentational_hints(&self, attr: &Attr) -> bool

Returns true if given attribute attr affects style of the given element.

fn parse_plain_attribute(&self, name: &LocalName, value: DOMString) -> AttrValue

Returns the right AttrValue variant for the attribute with name name on this element.

fn bind_to_tree(&self, context: &BindContext)

Called when a Node is appended to a tree, where ‘tree_connected’ indicates whether the tree is part of a Document.

fn handle_event(&self, event: &Event)

Called during event dispatch after the bubbling phase completes.

fn adopting_steps(&self, old_doc: &Document)

https://dom.spec.whatwg.org/#concept-node-adopt-ext

fn cloning_steps(
    &self,
    copy: &Node,
    maybe_doc: Option<&Document>,
    clone_children: CloneChildrenFlag
)

https://dom.spec.whatwg.org/#concept-node-clone-ext

fn pop(&self)

Called on an element when it is popped off the stack of open elements of a parser.

impl DerivedFrom<EventTarget> for Node

impl DerivedFrom<Node> for Attr

impl DerivedFrom<Node> for CDATASection

impl DerivedFrom<Node> for HTMLAudioElement

impl DerivedFrom<Node> for HTMLBRElement

impl DerivedFrom<Node> for HTMLBaseElement

impl DerivedFrom<Node> for HTMLBodyElement

impl DerivedFrom<Node> for HTMLButtonElement

impl DerivedFrom<Node> for HTMLCanvasElement

impl DerivedFrom<Node> for HTMLDListElement

impl DerivedFrom<Node> for HTMLDataElement

impl DerivedFrom<Node> for HTMLDataListElement

impl DerivedFrom<Node> for HTMLDetailsElement

impl DerivedFrom<Node> for CharacterData

impl DerivedFrom<Node> for HTMLDialogElement

impl DerivedFrom<Node> for HTMLDirectoryElement

impl DerivedFrom<Node> for HTMLDivElement

impl DerivedFrom<Node> for HTMLElement

impl DerivedFrom<Node> for HTMLEmbedElement

impl DerivedFrom<Node> for HTMLFieldSetElement

impl DerivedFrom<Node> for HTMLFontElement

impl DerivedFrom<Node> for HTMLFormElement

impl DerivedFrom<Node> for HTMLFrameElement

impl DerivedFrom<Node> for HTMLFrameSetElement

impl DerivedFrom<Node> for Comment

impl DerivedFrom<Node> for HTMLHRElement

impl DerivedFrom<Node> for HTMLHeadElement

impl DerivedFrom<Node> for HTMLHeadingElement

impl DerivedFrom<Node> for HTMLHtmlElement

impl DerivedFrom<Node> for HTMLIFrameElement

impl DerivedFrom<Node> for HTMLImageElement

impl DerivedFrom<Node> for HTMLInputElement

impl DerivedFrom<Node> for HTMLLIElement

impl DerivedFrom<Node> for HTMLLabelElement

impl DerivedFrom<Node> for HTMLLegendElement

impl DerivedFrom<Node> for Document

impl DerivedFrom<Node> for HTMLLinkElement

impl DerivedFrom<Node> for HTMLMapElement

impl DerivedFrom<Node> for HTMLMediaElement

impl DerivedFrom<Node> for HTMLMenuElement

impl DerivedFrom<Node> for HTMLMetaElement

impl DerivedFrom<Node> for HTMLMeterElement

impl DerivedFrom<Node> for HTMLModElement

impl DerivedFrom<Node> for HTMLOListElement

impl DerivedFrom<Node> for HTMLObjectElement

impl DerivedFrom<Node> for HTMLOptGroupElement

impl DerivedFrom<Node> for DocumentFragment

impl DerivedFrom<Node> for HTMLOptionElement

impl DerivedFrom<Node> for HTMLOutputElement

impl DerivedFrom<Node> for HTMLParagraphElement

impl DerivedFrom<Node> for HTMLParamElement

impl DerivedFrom<Node> for HTMLPictureElement

impl DerivedFrom<Node> for HTMLPreElement

impl DerivedFrom<Node> for HTMLProgressElement

impl DerivedFrom<Node> for HTMLQuoteElement

impl DerivedFrom<Node> for HTMLScriptElement

impl DerivedFrom<Node> for HTMLSelectElement

impl DerivedFrom<Node> for DocumentType

impl DerivedFrom<Node> for HTMLSourceElement

impl DerivedFrom<Node> for HTMLSpanElement

impl DerivedFrom<Node> for HTMLStyleElement

impl DerivedFrom<Node> for HTMLTableCaptionElement

impl DerivedFrom<Node> for HTMLTableCellElement

impl DerivedFrom<Node> for HTMLTableColElement

impl DerivedFrom<Node> for HTMLTableElement

impl DerivedFrom<Node> for HTMLTableRowElement

impl DerivedFrom<Node> for HTMLTableSectionElement

impl DerivedFrom<Node> for HTMLTemplateElement

impl DerivedFrom<Node> for Element

impl DerivedFrom<Node> for HTMLTextAreaElement

impl DerivedFrom<Node> for HTMLTimeElement

impl DerivedFrom<Node> for HTMLTitleElement

impl DerivedFrom<Node> for HTMLTrackElement

impl DerivedFrom<Node> for HTMLUListElement

impl DerivedFrom<Node> for HTMLUnknownElement

impl DerivedFrom<Node> for HTMLVideoElement

impl DerivedFrom<Node> for Node

impl DerivedFrom<Node> for ProcessingInstruction

impl DerivedFrom<Node> for SVGElement

impl DerivedFrom<Node> for HTMLAnchorElement

impl DerivedFrom<Node> for SVGGraphicsElement

impl DerivedFrom<Node> for SVGSVGElement

impl DerivedFrom<Node> for ShadowRoot

impl DerivedFrom<Node> for Text

impl DerivedFrom<Node> for XMLDocument

impl DerivedFrom<Node> for HTMLAreaElement