[−][src]Struct indextree::NodeId
Implementations
impl NodeId
[src]
pub fn ancestors<T>(self, arena: &Arena<T>) -> Ancestors<T>
[src]
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>
[src]
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>
[src]
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);
pub fn children<T>(self, arena: &Arena<T>) -> Children<T>
[src]
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>
[src]
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>
[src]
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);
pub fn traverse<T>(self, arena: &Arena<T>) -> Traverse<T>
[src]
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>
[src]
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);
pub fn detach<T>(self, arena: &mut Arena<T>)
[src]
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);
pub fn append<T>(self, new_child: NodeId, arena: &mut Arena<T>)
[src]
Appends a new child to this node, after existing children.
Panics
Panics if:
- the given new child is
self
, or - the current node or the given new child was already
remove
d.
To check if the node is removed or not, use Node::is_removed()
.
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);
pub fn checked_append<T>(
self,
new_child: NodeId,
arena: &mut Arena<T>
) -> Result<(), NodeError>
[src]
self,
new_child: NodeId,
arena: &mut Arena<T>
) -> Result<(), NodeError>
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.
To check if the node is removed or not, use Node::is_removed()
.
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());
pub fn prepend<T>(self, new_child: NodeId, arena: &mut Arena<T>)
[src]
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.
To check if the node is removed or not, use Node::is_removed()
.
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);
pub fn checked_prepend<T>(
self,
new_child: NodeId,
arena: &mut Arena<T>
) -> Result<(), NodeError>
[src]
self,
new_child: NodeId,
arena: &mut Arena<T>
) -> Result<(), NodeError>
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.
To check if the node is removed or not, use Node::is_removed()
.
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());
pub fn insert_after<T>(self, new_sibling: NodeId, arena: &mut Arena<T>)
[src]
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.
To check if the node is removed or not, use Node::is_removed()
.
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);
pub fn checked_insert_after<T>(
self,
new_sibling: NodeId,
arena: &mut Arena<T>
) -> Result<(), NodeError>
[src]
self,
new_sibling: NodeId,
arena: &mut Arena<T>
) -> Result<(), NodeError>
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.
To check if the node is removed or not, use Node::is_removed()
.
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());
pub fn insert_before<T>(self, new_sibling: NodeId, arena: &mut Arena<T>)
[src]
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.
To check if the node is removed or not, use Node::is_removed()
.
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);
pub fn checked_insert_before<T>(
self,
new_sibling: NodeId,
arena: &mut Arena<T>
) -> Result<(), NodeError>
[src]
self,
new_sibling: NodeId,
arena: &mut Arena<T>
) -> Result<(), NodeError>
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.
To check if the node is removed or not, use Node::is_removed()
.
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());
pub fn remove<T>(self, arena: &mut Arena<T>)
[src]
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.
To check if the node is removed or not, use Node::is_removed()
.
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);
Trait Implementations
impl Clone for NodeId
[src]
impl Copy for NodeId
[src]
impl Debug for NodeId
[src]
impl Display for NodeId
[src]
impl Eq for NodeId
[src]
impl Hash for NodeId
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T> Index<NodeId> for Arena<T>
[src]
type Output = Node<T>
The returned type after indexing.
fn index(&self, node: NodeId) -> &Node<T>
[src]
impl<T> IndexMut<NodeId> for Arena<T>
[src]
impl Into<NonZeroUsize> for NodeId
[src]
fn into(self) -> NonZeroUsize
[src]
impl Into<usize> for NodeId
[src]
impl Ord for NodeId
[src]
fn cmp(&self, other: &NodeId) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl PartialEq<NodeId> for NodeId
[src]
impl PartialOrd<NodeId> for NodeId
[src]
fn partial_cmp(&self, other: &NodeId) -> Option<Ordering>
[src]
fn lt(&self, other: &NodeId) -> bool
[src]
fn le(&self, other: &NodeId) -> bool
[src]
fn gt(&self, other: &NodeId) -> bool
[src]
fn ge(&self, other: &NodeId) -> bool
[src]
impl StructuralEq for NodeId
[src]
impl StructuralPartialEq for NodeId
[src]
Auto Trait Implementations
impl RefUnwindSafe for NodeId
impl Send for NodeId
impl Sync for NodeId
impl Unpin for NodeId
impl UnwindSafe for NodeId
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,