Struct NodeRef 

pub struct NodeRef<'a> { /* private fields */ }

A lightweight, Copy read handle to a single node, bound to its Dom.

All traversal (parent, children, descendants, ancestors, siblings) is O(1) per step thanks to the arena’s links.

Implementations

impl<'a> NodeRef<'a>

pub fn id(&self) -> NodeId

This node’s arena id.

pub fn kind(&self) -> NodeKind<'a>

The node’s kind (element / text / comment / doctype) as a borrowed view.

pub fn is_element(&self) -> bool

Whether this node is an element.

pub fn is_text(&self) -> bool

Whether this node is a text node.

pub fn tag_name(&self) -> Option<&'a str>

The tag name (lower-cased), if this node is an element.

pub fn attr(&self, name: &str) -> Option<&'a str>

The value of attribute name, if this is an element with that attribute.

pub fn has_attr(&self, name: &str) -> bool

Whether attribute name is present (including valueless boolean attrs).

pub fn attributes(&self) -> impl Iterator<Item = (&'a str, &'a str)>

All (name, value) attribute pairs (empty iterator for non-elements).

pub fn classes(&self) -> impl Iterator<Item = &'a str>

The class names on this element.

pub fn has_class(&self, class: &str) -> bool

Whether this element has the given class.

pub fn text(&self) -> Option<&'a str>

This node’s own text, if it is a text node (already entity-decoded).

pub fn comment(&self) -> Option<&'a str>

The body text of this comment node, if it is one.

pub fn text_content(&self) -> String

Concatenated text of this node and all its descendants, in document order (entity-decoded). Equivalent to the DOM textContent.

pub fn parent(&self) -> Option<NodeRef<'a>>

This node’s parent, if any.

pub fn first_child(&self) -> Option<NodeRef<'a>>

The first child, if any.

pub fn last_child(&self) -> Option<NodeRef<'a>>

The last child, if any.

pub fn next_sibling(&self) -> Option<NodeRef<'a>>

The next sibling, if any.

pub fn prev_sibling(&self) -> Option<NodeRef<'a>>

The previous sibling, if any.

pub fn children(&self) -> impl Iterator<Item = NodeRef<'a>>

This node’s direct children, in order.

pub fn child_elements(&self) -> impl Iterator<Item = NodeRef<'a>>

Child elements only (skips text/comment/doctype nodes).

pub fn ancestors(&self) -> impl Iterator<Item = NodeRef<'a>>

This node’s ancestors, from parent up to the root.

pub fn descendants(&self) -> Descendants<'a>

All descendants of this node, in document (pre-order) order. Does not include the node itself. Allocation-free.

impl<'a> NodeRef<'a>

pub fn to_html(&self) -> String

Serialize just this node and its subtree back to an HTML string.

let dom = domtree::parse("<div><img src=a.png><br></div>");
let div = dom.find_by_tag("div").next().unwrap();
assert_eq!(div.to_html(), r#"<div><img src="a.png"><br></div>"#);

impl<'a> NodeRef<'a>

pub fn to_json(&self) -> String

Available on crate feature json only.

Serialize just this node and its subtree to a compact JSON string, using the same shape as Dom::to_json.

let dom = domtree::parse("<div><b>hi</b></div>");
let b = dom.find_by_tag("b").next().unwrap();
assert_eq!(b.to_json(), r#"{"type":"element","tag":"b","attrs":{},"children":[{"type":"text","value":"hi"}]}"#);

Trait Implementations

impl<'a> Clone for NodeRef<'a>

fn clone(&self) -> NodeRef<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for NodeRef<'a>

impl<'a> Debug for NodeRef<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Serialize for NodeRef<'a>

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.