Struct rin::ecs::NodeId

pub struct NodeId { /* fields omitted */ }

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>) -> NodeRefMut<'_, 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>
) -> NodeRefMut<'_, T>

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

pub fn append_new<T>(
    self,
    new_data: T,
    arena: &mut Arena<T>
) -> NodeRefMut<'_, T>

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

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

pub fn prepend_new<T>(
    self,
    new_data: T,
    arena: &mut Arena<T>
) -> NodeRefMut<'_, T>

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

Insert a new sibling after this node.

pub fn insert_after_new<T>(
    self,
    new_data: T,
    arena: &mut Arena<T>
) -> NodeRefMut<'_, T>

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

Insert a new sibling before this node.

pub fn insert_before_new<T>(
    self,
    new_data: T,
    arena: &mut Arena<T>
) -> NodeRefMut<'_, T>

Trait Implementations

impl Clone for NodeId

pub fn clone(&self) -> NodeId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeId

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

Formats the value using the given formatter.

impl<T> From<Node<T>> for NodeId

pub fn from(node: Node<T>) -> NodeId

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl PartialEq<NodeId> for NodeId

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

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

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

This method tests for !=.

impl Copy for NodeId

impl Eq for NodeId

impl StructuralEq for NodeId

impl StructuralPartialEq for NodeId