Struct NodeRef

pub struct NodeRef<T>(/* private fields */);

A reference to a node holding a value of type T. Nodes form a tree.

Internally, this uses reference counting for lifetime tracking and std::cell::RefCell for interior mutability.

Note: Cloning a NodeRef only increments a reference count. It does not copy the data.

Implementations

impl<T> NodeRef<T>

pub fn new(data: T) -> NodeRef<T>

Create a new node from its associated data.

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

Return a reference to the parent node, unless this node is the root of the tree.

Panics

Panics if the node is currently mutability borrowed.

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

Return a reference to the first child of this node, unless it has no child.

Panics

Panics if the node is currently mutability borrowed.

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

Return a reference to the last child of this node, unless it has no child.

Panics

Panics if the node is currently mutability borrowed.

pub fn previous_sibling(&self) -> Option<NodeRef<T>>

Return a reference to the previous sibling of this node, unless it is a first child.

Panics

Panics if the node is currently mutability borrowed.

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

Return a reference to the previous sibling of this node, unless it is a first child.

Panics

Panics if the node is currently mutability borrowed.

pub fn borrow(&self) -> Ref<'_, T>

Return a shared reference to this node’s data

Panics

Panics if the node is currently mutability borrowed.

pub fn borrow_mut(&self) -> RefMut<'_, T>

Return a unique/mutable reference to this node’s data

Panics

Panics if the node is currently borrowed.

pub fn same_node(&self, other: &NodeRef<T>) -> bool

Returns whether two references point to the same node.

pub fn ancestors(&self) -> Ancestors<T>

Return an iterator of references to this node and its ancestors.

Call .next().unwrap() once on the iterator to skip the node itself.

pub fn preceding_siblings(&self) -> PrecedingSiblings<T>

Return an iterator of references to this node and the siblings before it.

Call .next().unwrap() once on the iterator to skip the node itself.

pub fn following_siblings(&self) -> FollowingSiblings<T>

Return an iterator of references to this node and the siblings after it.

Call .next().unwrap() once on the iterator to skip the node itself.

pub fn children(&self) -> Children<T>

Return an iterator of references to this node’s children.

Panics

Panics if the node is currently mutability borrowed.

pub fn reverse_children(&self) -> ReverseChildren<T>

Return an iterator of references to this node’s children, in reverse order.

Panics

Panics if the node is currently mutability borrowed.

pub fn descendants(&self) -> Descendants<T>

Return an iterator of references to this node and its descendants, in tree order.

Parent nodes appear before the descendants. Call .next().unwrap() once on the iterator to skip the node itself.

pub fn traverse(&self) -> Traverse<T>

Return an iterator of references to this node and its descendants, in tree order.

pub fn reverse_traverse(&self) -> ReverseTraverse<T>

Return an iterator of references to this node and its descendants, in tree order.

pub fn detach(&self)

Detach a node from its parent and siblings. Children are not affected.

Panics

Panics if the node or one of its adjoining nodes is currently borrowed.

pub fn append(&self, new_child: NodeRef<T>)

Append a new child to this node, after existing children.

Panics

Panics if the node, the new child, or one of their adjoining nodes is currently borrowed.

pub fn prepend(&self, new_child: NodeRef<T>)

Prepend a new child to this node, before existing children.

Panics

Panics if the node, the new child, or one of their adjoining nodes is currently borrowed.

pub fn insert_after(&self, new_sibling: NodeRef<T>)

Insert a new sibling after this node.

Panics

Panics if the node, the new sibling, or one of their adjoining nodes is currently borrowed.

pub fn insert_before(&self, new_sibling: NodeRef<T>)

Insert a new sibling before this node.

Panics

Panics if the node, the new sibling, or one of their adjoining nodes is currently borrowed.

Trait Implementations

impl<T> Clone for NodeRef<T>

Cloning a NodeRef only increments a reference count. It does not copy the data.

fn clone(&self) -> NodeRef<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for NodeRef<T>

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

Formats the value using the given formatter.