Struct NodeId

pub struct NodeId { /* private fields */ }

A node identifier within a particular Arena

Implementations

impl NodeId

pub fn ancestors<T>(self, arena: &Arena<T>) -> 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<T>(self, arena: &Arena<T>) -> 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<T>(self, arena: &Arena<T>) -> 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<T>(self, arena: &Arena<T>) -> Children<'_, T>

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

pub fn reverse_children<T>(self, arena: &Arena<T>) -> ReverseChildren<'_, T>

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

pub fn descendants<T>(self, arena: &Arena<T>) -> 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<T>(self, arena: &Arena<T>) -> Traverse<'_, T>

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

pub fn reverse_traverse<T>(self, arena: &Arena<T>) -> ReverseTraverse<'_, T>

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

pub fn detach<T>(self, arena: &mut Arena<T>)

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

pub fn append<T>( self, new_child: NodeId, arena: &mut Arena<T>, ) -> Result<(), IndexTreeError>

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

pub fn prepend<T>( self, new_child: NodeId, arena: &mut Arena<T>, ) -> Result<(), IndexTreeError>

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

pub fn insert_after<T>( self, new_sibling: NodeId, arena: &mut Arena<T>, ) -> Result<(), IndexTreeError>

Insert a new sibling after this node.

pub fn insert_before<T>( self, new_sibling: NodeId, arena: &mut Arena<T>, ) -> Result<(), IndexTreeError>

Insert a new sibling before this node.

Trait Implementations

impl Clone for NodeId

fn clone(&self) -> NodeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeId

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

Formats the value using the given formatter.

impl Hash for NodeId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Index<NodeId> for Arena<T>

type Output = Node<T>

The returned type after indexing.

fn index(&self, node: NodeId) -> &Node<T>

Performs the indexing (container[index]) operation.

impl<T> IndexMut<NodeId> for Arena<T>

fn index_mut(&mut self, node: NodeId) -> &mut Node<T>

Performs the mutable indexing (container[index]) operation.

impl PartialEq for NodeId

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for NodeId

impl Eq for NodeId

impl StructuralPartialEq for NodeId