Struct rin::ecs::NodeRef

pub struct NodeRef<'a, T> where
    T: 'a,  { /* fields omitted */ }

Implementations

impl<'a, T> NodeRef<'a, T> where
    T: 'a, 

pub fn id(&self) -> NodeId

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

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

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

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

pub fn descendants(&self) -> 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 ancestors_ref(&self) -> AncestorsRef<'_, 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_ref(&self) -> PrecedingSiblingsRef<'_, 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_ref(&self) -> FollowingSiblingsRef<'_, 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_ref(&self) -> ChildrenRef<'_, T>

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

pub fn reverse_children_ref(&self) -> ReverseChildrenRef<'_, T>

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

pub fn descendants_ref(&self) -> DescendantsRef<'_, 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(&self) -> Traverse<'_, T>

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

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

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

pub fn parent(&self) -> Option<NodeRef<'a, T>>

Return the ID of the parent node, unless this node is the root of the tree.

Trait Implementations

impl<'a, T> Deref for NodeRef<'a, T> where
    T: 'a, 

type Target = Node<T>

The resulting type after dereferencing.

pub fn deref(&self) -> &Node<T>

Dereferences the value.

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

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

Performs the conversion.