Struct rctree::Node

pub struct Node<T>(_);

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 Node only increments a reference count. It does not copy the data.

Methods

impl<T> Node<T>

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

Creates a new node from its associated data.

pub fn downgrade(&self) -> WeakNode<T>

Returns a weak referece to a node.

pub fn root(&self) -> Node<T>

Returns a root node.

If the current node is the root node - will return itself.

Panics

Panics if the node is currently mutably borrowed.

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

Returns a parent node, unless this node is the root of the tree.

Panics

Panics if the node is currently mutably borrowed.

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

Returns a first child of this node, unless it has no child.

Panics

Panics if the node is currently mutably borrowed.

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

Returns a last child of this node, unless it has no child.

Panics

Panics if the node is currently mutably borrowed.

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

Returns the previous sibling of this node, unless it is a first child.

Panics

Panics if the node is currently mutably borrowed.

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

Returns the next sibling of this node, unless it is a last child.

Panics

Panics if the node is currently mutably borrowed.

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

Returns a shared reference to this node's data

Panics

Panics if the node is currently mutably borrowed.

pub fn borrow_mut(&mut self) -> RefMut<T>

Returns a unique/mutable reference to this node's data

Panics

Panics if the node is currently borrowed.

Important traits for Ancestors<T>

impl<T> Iterator for Ancestors<T> type Item = Node<T>;

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

Returns an iterator of nodes to this node and its ancestors.

Includes the current node.

Important traits for PrecedingSiblings<T>

impl<T> Iterator for PrecedingSiblings<T> type Item = Node<T>;

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

Returns an iterator of nodes to this node and the siblings before it.

Includes the current node.

Important traits for FollowingSiblings<T>

impl<T> Iterator for FollowingSiblings<T> type Item = Node<T>;

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

Returns an iterator of nodes to this node and the siblings after it.

Includes the current node.

Important traits for Children<T>

impl<T> Iterator for Children<T> type Item = Node<T>;

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

Returns an iterator of nodes to this node's children.

Panics

Panics if the node is currently mutably borrowed.

pub fn has_children(&self) -> bool

Returns true if this node has children nodes.

Panics

Panics if the node is currently mutably borrowed.

Important traits for Descendants<T>

impl<T> Iterator for Descendants<T> type Item = Node<T>;

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

Returns an iterator of nodes to this node and its descendants, in tree order.

Includes the current node.

Important traits for Traverse<T>

impl<T> Iterator for Traverse<T> type Item = NodeEdge<T>;

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

Returns an iterator of nodes to this node and its descendants, in tree order.

pub fn detach(&mut self)

Detaches 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(&mut self, new_child: Node<T>)

Appends 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(&mut self, new_child: Node<T>)

Prepends 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(&mut self, new_sibling: Node<T>)

Inserts 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(&mut self, new_sibling: Node<T>)

Inserts a new sibling before this node.

Panics

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

pub fn make_copy(&mut self) -> Node<T> where
    T: Clone, 

Returns a copy of a current node without children.

Panics

Panics if the node is currently mutably borrowed.

pub fn make_deep_copy(&mut self) -> Node<T> where
    T: Clone, 

Returns a copy of a current node with children.

Panics

Panics if any of the descendant nodes are currently mutably borrowed.

Trait Implementations

impl<T> PartialEq<Node<T>> for Node<T>

fn eq(&self, other: &Node<T>) -> 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<T> Clone for Node<T>

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Node<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for Node<T>

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

Formats the value using the given formatter.