Struct marked::NodeRef

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

A Node within Document lifetime reference.

This provides convenient but necessarily read-only access.

Methods

impl<'a> NodeRef<'a>

pub fn new(doc: &'a Document, id: NodeId) -> Self

Constructor.

pub fn id(&self) -> NodeId

Return the associated NodeId.

pub fn select_children<P>(
    &'a self,
    predicate: P
) -> impl Iterator<Item = NodeRef<'a>> + 'a where
    P: FnMut(&NodeRef<'a>) -> bool + 'a, 

Return an iterator over the direct children of this node that match the specified predicate.

This is a convenence short hand for children().filter(predicate). The "filter" name is avoided in deference to the (mutating) Document::filter method.

pub fn select<P>(&'a self, predicate: P) -> Selector<'a, P> where
    P: FnMut(&NodeRef<'a>) -> bool + 'a, 

Return an iterator over all decendents of this node that match the specified predicate.

When element nodes fail the predicate, their children are scanned, depth-first, in search of all matches.

pub fn find_child<P>(&'a self, predicate: P) -> Option<NodeRef<'a>> where
    P: FnMut(&NodeRef<'a>) -> bool, 

Find the first direct child of this node that matches the specified predicate.

This is a convenence short hand for children().find(predicate).

pub fn find<P>(&'a self, predicate: P) -> Option<NodeRef<'a>> where
    P: FnMut(&NodeRef<'a>) -> bool + 'a, 

Find the first descendant of this node that matches the specified predicate.

When element nodes fail the predicate, their children are scanned, depth-first, in search of the first match.

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

Return an iterator over node's direct children.

Will yield nothing if the node can not or does not have children.

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

Return an iterator yielding self and all ancestors, terminating at the document node.

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

Return any parent node or None.

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

Return any previous (left) sibling node or None.

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

Return any subsequent next (right) sibling node or None.

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

Return all decendent text content (character data) of this node.

If this is a Text node, return that text. If this is an Element node or the Document root node, return the concatentation of all text descendants, in tree order. Returns None for all other node types.

pub fn deep_clone(&'a self) -> Document

Create a new independent Document from the ordered sub-tree referenced by self.

impl<'a> NodeRef<'a>

Serialize convenience method.

pub fn serialize<W>(&'a self, writer: &mut W) -> Result<()> where
    W: Write, 

Serialize the referenced node and its descendants in HTML syntax to the given stream.

Methods from Deref<Target = Node>

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

impl<'_> Debug for NodeRef<'_>

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

Formats the value using the given formatter.

impl<'a> Deref for NodeRef<'a>

type Target = Node

The resulting type after dereferencing.

fn deref(&self) -> &Node

Dereferences the value.

impl<'_> PartialEq<NodeRef<'_>> for NodeRef<'_>

Equivalence is defined here for NodeRefs if and only if they reference the same Document (by identity) and with equal NodeIds.

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

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

impl<'a> ToString for NodeRef<'a>

Implemented via NodeRef::serialize.

fn to_string(&self) -> String

Converts the given value to a String.