Struct generational_indextree::NodeId
source · [−]pub struct NodeId { /* private fields */ }
Expand description
Implementations
Returns an iterator of IDs of this node and its ancestors.
Use .skip(1)
or call .next()
once on the iterator to skip
the node itself.
Examples
// arena
// `-- 1
// |-- 1_1
// | `-- 1_1_1
// | `-- 1_1_1_1
// _-- 1_2
// `-- 1_3
let mut iter = n1_1_1.ancestors(&arena);
assert_eq!(iter.next(), Some(n1_1_1));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), Some(n1));
assert_eq!(iter.next(), None);
pub fn preceding_siblings<T>(self, arena: &Arena<T>) -> PrecedingSiblings<'_, T>ⓘNotable 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>ⓘNotable traits for PrecedingSiblings<'a, T>impl<'a, T> Iterator for PrecedingSiblings<'a, T> type Item = NodeId;
impl<'a, T> Iterator for PrecedingSiblings<'a, T> type Item = NodeId;
Returns an iterator of IDs of this node and the siblings before it.
Use .skip(1)
or call .next()
once on the iterator to skip
the node itself.
Examples
// arena
// `-- 1
// |-- 1_1
// | `-- 1_1_1
// |-- 1_2
// `-- 1_3
let mut iter = n1_2.preceding_siblings(&arena);
assert_eq!(iter.next(), Some(n1_2));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), None);
pub fn following_siblings<T>(self, arena: &Arena<T>) -> FollowingSiblings<'_, T>ⓘNotable 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>ⓘNotable traits for FollowingSiblings<'a, T>impl<'a, T> Iterator for FollowingSiblings<'a, T> type Item = NodeId;
impl<'a, T> Iterator for FollowingSiblings<'a, T> type Item = NodeId;
Returns an iterator of IDs of this node and the siblings after it.
Use .skip(1)
or call .next()
once on the iterator to skip
the node itself.
Examples
// arena
// `-- 1
// |-- 1_1
// | `-- 1_1_1
// |-- 1_2
// `-- 1_3
let mut iter = n1_2.following_siblings(&arena);
assert_eq!(iter.next(), Some(n1_2));
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), None);
Returns an iterator of IDs of this node’s children.
Examples
// arena
// `-- 1
// |-- 1_1
// | `-- 1_1_1
// |-- 1_2
// `-- 1_3
let mut iter = n1.children(&arena);
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), Some(n1_2));
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), None);
pub fn reverse_children<T>(self, arena: &Arena<T>) -> ReverseChildren<'_, T>ⓘNotable 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>ⓘNotable traits for ReverseChildren<'a, T>impl<'a, T> Iterator for ReverseChildren<'a, T> type Item = NodeId;
impl<'a, T> Iterator for ReverseChildren<'a, T> type Item = NodeId;
Returns an iterator of IDs of this node’s children, in reverse order.
Examples
// arena
// `-- 1
// |-- 1_1
// | `-- 1_1_1
// |-- 1_2
// `-- 1_3
let mut iter = n1.reverse_children(&arena);
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), Some(n1_2));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), None);
pub fn descendants<T>(self, arena: &Arena<T>) -> Descendants<'_, T>ⓘNotable 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>ⓘNotable traits for Descendants<'a, T>impl<'a, T> Iterator for Descendants<'a, T> type Item = NodeId;
impl<'a, T> Iterator for Descendants<'a, T> type Item = NodeId;
An iterator of the IDs of a given node and its descendants, as a pre-order depth-first search where children are visited in insertion order.
i.e. node -> first child -> second child
Parent nodes appear before the descendants.
Use .skip(1)
or call .next()
once on the iterator to skip
the node itself.
Examples
// arena
// `-- 1
// |-- 1_1
// | `-- 1_1_1
// | `-- 1_1_1_1
// |-- 1_2
// `-- 1_3
let mut iter = n1.descendants(&arena);
assert_eq!(iter.next(), Some(n1));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), Some(n1_1_1));
assert_eq!(iter.next(), Some(n1_1_1_1));
assert_eq!(iter.next(), Some(n1_2));
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), None);
An iterator of the “sides” of a node visited during a depth-first pre-order traversal, where node sides are visited start to end and children are visited in insertion order.
i.e. node.start -> first child -> second child -> node.end
Examples
// arena
// `-- 1
// |-- 1_1
// | `-- 1_1_1
// |-- 1_2
// `-- 1_3
let mut iter = n1.traverse(&arena);
assert_eq!(iter.next(), Some(NodeEdge::Start(n1)));
assert_eq!(iter.next(), Some(NodeEdge::Start(n1_1)));
assert_eq!(iter.next(), Some(NodeEdge::Start(n1_1_1)));
assert_eq!(iter.next(), Some(NodeEdge::End(n1_1_1)));
assert_eq!(iter.next(), Some(NodeEdge::End(n1_1)));
assert_eq!(iter.next(), Some(NodeEdge::Start(n1_2)));
assert_eq!(iter.next(), Some(NodeEdge::End(n1_2)));
assert_eq!(iter.next(), Some(NodeEdge::Start(n1_3)));
assert_eq!(iter.next(), Some(NodeEdge::End(n1_3)));
assert_eq!(iter.next(), Some(NodeEdge::End(n1)));
assert_eq!(iter.next(), None);
pub fn reverse_traverse<T>(self, arena: &Arena<T>) -> ReverseTraverse<'_, T>ⓘNotable traits for ReverseTraverse<'a, T>impl<'a, T> Iterator for ReverseTraverse<'a, T> type Item = NodeEdge;
pub fn reverse_traverse<T>(self, arena: &Arena<T>) -> ReverseTraverse<'_, T>ⓘNotable traits for ReverseTraverse<'a, T>impl<'a, T> Iterator for ReverseTraverse<'a, T> type Item = NodeEdge;
impl<'a, T> Iterator for ReverseTraverse<'a, T> type Item = NodeEdge;
An iterator of the “sides” of a node visited during a depth-first pre-order traversal, where nodes are visited end to start and children are visited in reverse insertion order.
i.e. node.end -> second child -> first child -> node.start
Examples
// arena
// `-- 1
// |-- 1_1
// | `-- 1_1_1
// |-- 1_2
// `-- 1_3
let mut iter = n1.reverse_traverse(&arena);
assert_eq!(iter.next(), Some(NodeEdge::End(n1)));
assert_eq!(iter.next(), Some(NodeEdge::End(n1_3)));
assert_eq!(iter.next(), Some(NodeEdge::Start(n1_3)));
assert_eq!(iter.next(), Some(NodeEdge::End(n1_2)));
assert_eq!(iter.next(), Some(NodeEdge::Start(n1_2)));
assert_eq!(iter.next(), Some(NodeEdge::End(n1_1)));
assert_eq!(iter.next(), Some(NodeEdge::End(n1_1_1)));
assert_eq!(iter.next(), Some(NodeEdge::Start(n1_1_1)));
assert_eq!(iter.next(), Some(NodeEdge::Start(n1_1)));
assert_eq!(iter.next(), Some(NodeEdge::Start(n1)));
assert_eq!(iter.next(), None);
let traverse = n1.traverse(&arena).collect::<Vec<_>>();
let mut reverse = n1.reverse_traverse(&arena).collect::<Vec<_>>();
reverse.reverse();
assert_eq!(traverse, reverse);
Detaches a node from its parent and siblings. Children are not affected.
Examples
// arena
// `-- (implicit)
// `-- 1
// |-- 1_1
// | `-- 1_1_1
// |-- 1_2 *
// `-- 1_3
n1_2.detach(&mut arena);
// arena
// |-- (implicit)
// | `-- 1
// | |-- 1_1
// | | `-- 1_1_1
// | `-- 1_3
// `-- (implicit)
// `-- 1_2
assert!(arena[n1_2].parent().is_none());
assert!(arena[n1_2].previous_sibling().is_none());
assert!(arena[n1_2].next_sibling().is_none());
let mut iter = n1.descendants(&arena);
assert_eq!(iter.next(), Some(n1));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), Some(n1_1_1));
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), None);
Appends a new child to this node, after existing children.
Panics
Panics if:
- the given new child is
self
Examples
let mut arena = Arena::new();
let n1 = arena.new_node("1");
let n1_1 = arena.new_node("1_1");
n1.append(n1_1, &mut arena);
let n1_2 = arena.new_node("1_2");
n1.append(n1_2, &mut arena);
let n1_3 = arena.new_node("1_3");
n1.append(n1_3, &mut arena);
// arena
// `-- 1
// |-- 1_1
// |-- 1_2
// `-- 1_3
let mut iter = n1.descendants(&arena);
assert_eq!(iter.next(), Some(n1));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), Some(n1_2));
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), None);
Appends a new child to this node, after existing children.
Failures
- Returns
NodeError::AppendSelf
error if the given new child isself
. - Returns
NodeError::Removed
error if the given new child orself
isremove
d.
Examples
let mut arena = Arena::new();
let n1 = arena.new_node("1");
assert!(n1.checked_append(n1, &mut arena).is_err());
let n1_1 = arena.new_node("1_1");
assert!(n1.checked_append(n1_1, &mut arena).is_ok());
Prepends a new child to this node, before existing children.
Panics
Panics if:
- the given new child is
self
, or - the current node or the given new child was already
remove
d.
Examples
let mut arena = Arena::new();
let n1 = arena.new_node("1");
let n1_1 = arena.new_node("1_1");
n1.prepend(n1_1, &mut arena);
let n1_2 = arena.new_node("1_2");
n1.prepend(n1_2, &mut arena);
let n1_3 = arena.new_node("1_3");
n1.prepend(n1_3, &mut arena);
// arena
// `-- 1
// |-- 1_3
// |-- 1_2
// `-- 1_1
let mut iter = n1.descendants(&arena);
assert_eq!(iter.next(), Some(n1));
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), Some(n1_2));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), None);
Prepends a new child to this node, before existing children.
Failures
- Returns
NodeError::PrependSelf
error if the given new child isself
. - Returns
NodeError::Removed
error if the given new child orself
isremove
d.
Examples
let mut arena = Arena::new();
let n1 = arena.new_node("1");
assert!(n1.checked_prepend(n1, &mut arena).is_err());
let n1_1 = arena.new_node("1_1");
assert!(n1.checked_prepend(n1_1, &mut arena).is_ok());
Inserts a new sibling after this node.
Panics
Panics if:
- the given new sibling is
self
, or - the current node or the given new sibling was already
remove
d.
Examples
// arena
// `-- 1
// |-- 1_1
// `-- 1_2
let n1_3 = arena.new_node("1_3");
n1_1.insert_after(n1_3, &mut arena);
// arena
// `-- 1
// |-- 1_1
// |-- 1_3
// `-- 1_2
let mut iter = n1.descendants(&arena);
assert_eq!(iter.next(), Some(n1));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), Some(n1_2));
assert_eq!(iter.next(), None);
Inserts a new sibling after this node.
Failures
- Returns
NodeError::InsertAfterSelf
error if the given new sibling isself
. - Returns
NodeError::Removed
error if the given new sibling orself
isremove
d.
Examples
let mut arena = Arena::new();
let n1 = arena.new_node("1");
assert!(n1.checked_insert_after(n1, &mut arena).is_err());
let n2 = arena.new_node("2");
assert!(n1.checked_insert_after(n2, &mut arena).is_ok());
Inserts a new sibling before this node.
Panics
Panics if:
- the given new sibling is
self
, or - the current node or the given new sibling was already
remove
d.
Examples
let mut arena = Arena::new();
let n1 = arena.new_node("1");
let n1_1 = arena.new_node("1_1");
n1.append(n1_1, &mut arena);
let n1_2 = arena.new_node("1_2");
n1.append(n1_2, &mut arena);
// arena
// `-- 1
// |-- 1_1
// `-- 1_2
let n1_3 = arena.new_node("1_3");
n1_2.insert_before(n1_3, &mut arena);
// arena
// `-- 1
// |-- 1_1
// |-- 1_3
// `-- 1_2
let mut iter = n1.descendants(&arena);
assert_eq!(iter.next(), Some(n1));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), Some(n1_2));
assert_eq!(iter.next(), None);
Inserts a new sibling before this node.
Failures
- Returns
NodeError::InsertBeforeSelf
error if the given new sibling isself
. - Returns
NodeError::Removed
error if the given new sibling orself
isremove
d.
Examples
let mut arena = Arena::new();
let n1 = arena.new_node("1");
assert!(n1.checked_insert_before(n1, &mut arena).is_err());
let n2 = arena.new_node("2");
assert!(n1.checked_insert_before(n2, &mut arena).is_ok());
Removes a node from the arena.
Children of the removed node will be inserted to the place where the removed node was.
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.
Examples
// arena
// `-- 1
// |-- 1_1
// |-- 1_2
// | |-- 1_2_1
// | `-- 1_2_2
// `-- 1_3
n1_2.remove(&mut arena);
let mut iter = n1.descendants(&arena);
assert_eq!(iter.next(), Some(n1));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), Some(n1_2_1));
assert_eq!(iter.next(), Some(n1_2_2));
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), None);
Removes a node and its descendants from the arena.
Examples
// arena
// `-- 1
// |-- 1_1
// |-- 1_2
// | |-- 1_2_1
// | `-- 1_2_2
// `-- 1_3
n1_2.remove_subtree(&mut arena);
let mut iter = n1.descendants(&arena);
assert_eq!(iter.next(), Some(n1));
assert_eq!(iter.next(), Some(n1_1));
assert_eq!(iter.next(), Some(n1_3));
assert_eq!(iter.next(), None);
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl RefUnwindSafe for NodeId
impl UnwindSafe for NodeId
Blanket Implementations
Mutably borrows from an owned value. Read more