Struct rin::util::idtree::NodeIdMut

pub struct NodeIdMut<'a, T: 'a> { /* fields omitted */ }

Methods

impl<'a, T: 'a> NodeIdMut<'a, T>

pub fn id(&self) -> NodeId

pub fn append<N: Into<NodeId>>(self, new_node: N) -> NodeIdMut<'a, T>

pub fn append_new(self, new_data: T) -> NodeIdMut<'a, T>

pub fn prepend<N: Into<NodeId>>(self, new_node: N) -> NodeIdMut<'a, T>

pub fn prepend_new(self, new_data: T) -> NodeIdMut<'a, T>

pub fn insert_after<N: Into<NodeId>>(self, new_node: N) -> NodeIdMut<'a, T>

pub fn insert_after_new(self, new_data: T) -> NodeIdMut<'a, T>

pub fn insert_before<N: Into<NodeId>>(self, new_node: N) -> NodeIdMut<'a, T>

pub fn insert_before_new(self, new_data: T) -> NodeIdMut<'a, T>

Important traits for Ancestors<'a, T>

impl<'a, T> Iterator for Ancestors<'a, T> type Item = NodeId;

pub fn ancestors(self) -> Ancestors<'a, T>

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

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

Important traits for PrecedingSiblings<'a, T>

impl<'a, T> Iterator for PrecedingSiblings<'a, T> type Item = NodeId;

pub fn preceding_siblings(self) -> PrecedingSiblings<'a, 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.

Important traits for FollowingSiblings<'a, T>

impl<'a, T> Iterator for FollowingSiblings<'a, T> type Item = NodeId;

pub fn following_siblings(self) -> FollowingSiblings<'a, 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.

Important traits for Children<'a, T>

impl<'a, T> Iterator for Children<'a, T> type Item = NodeId;

pub fn children(self) -> Children<'a, T>

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

Important traits for ReverseChildren<'a, T>

impl<'a, T> Iterator for ReverseChildren<'a, T> type Item = NodeId;

pub fn reverse_children(self) -> ReverseChildren<'a, T>

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

Important traits for Descendants<'a, T>

impl<'a, T> Iterator for Descendants<'a, T> type Item = NodeId;

pub fn descendants(self) -> Descendants<'a, 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.

Important traits for Traverse<'a, T>

impl<'a, T> Iterator for Traverse<'a, T> type Item = NodeEdge<NodeId>;

pub fn traverse(self) -> Traverse<'a, T>

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

Important traits for ReverseTraverse<'a, T>

impl<'a, T> Iterator for ReverseTraverse<'a, T> type Item = NodeEdge<NodeId>;

pub fn reverse_traverse(self) -> ReverseTraverse<'a, T>

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

Methods from Deref<Target = Node<T>>

pub fn id(&self) -> NodeId

pub fn parent(&self) -> Option<NodeId>

Return the ID of the parent node, unless this node is the root of the tree.

pub fn first_child(&self) -> Option<NodeId>

Return the ID of the first child of this node, unless it has no child.

pub fn last_child(&self) -> Option<NodeId>

Return the ID of the last child of this node, unless it has no child.

pub fn previous_sibling(&self) -> Option<NodeId>

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

pub fn next_sibling(&self) -> Option<NodeId>

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

Trait Implementations

impl<'a, T> From<NodeIdMut<'a, T>> for NodeId

fn from(node: NodeIdMut<'a, T>) -> NodeId

Performs the conversion.

impl<'a, T: 'a> Deref for NodeIdMut<'a, T>

type Target = Node<T>

The resulting type after dereferencing.

fn deref(&self) -> &Node<T>

Dereferences the value.

impl<'a, T: 'a> DerefMut for NodeIdMut<'a, T>

fn deref_mut(&mut self) -> &mut Node<T>

Mutably dereferences the value.