Struct indextree::NodeId

pub struct NodeId { /* fields omitted */ }

A node identifier within a particular Arena

Methods

impl NodeId

pub fn new(index0: usize) -> Self

Create a NodeId used for attempting to get Nodes references from an Arena.

Note that a zero-based index should be given.

Panics

Panics if the value is usize::max_value().

pub fn from_non_zero_usize(index1: NonZeroUsize) -> Self

Creates a new NodeId from the given one-based index.

Important traits for Ancestors<'a, T>

impl<'a, T> Iterator for Ancestors<'a, T> type Item = 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.

Important traits for PrecedingSiblings<'a, T>

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

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.

Important traits for FollowingSiblings<'a, T>

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

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.

Important traits for Children<'a, T>

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

pub fn children<T>(self, arena: &Arena<T>) -> Children<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<T>(self, arena: &Arena<T>) -> ReverseChildren<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<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.

Important traits for Traverse<'a, T>

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

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

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

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

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

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

Insert a new sibling after this node.

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

Insert a new sibling before this node. success.

pub fn remove<T>(self, arena: &mut Arena<T>) -> Fallible<()>

Remove a node from the arena. Available children of the removed node will be append to the parent after the previous sibling if available.

Please note that the node will not be removed from the internal arena storage, but marked as removed. Traversing the arena returns a plain iterator and contains removed elements too.

Trait Implementations

impl Eq for NodeId

impl Copy for NodeId

impl PartialOrd<NodeId> for NodeId

fn partial_cmp(&self, other: &NodeId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<NodeId> for NodeId

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

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

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

This method tests for !=.

impl Clone for NodeId

fn clone(&self) -> NodeId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for NodeId

fn cmp(&self, other: &NodeId) -> Ordering

This method returns an Ordering between self and other.

default fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

default fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

default fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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].

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

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 Display for NodeId

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

Formats the value using the given formatter.