Struct comrak::arena_tree::Node [−][src]
pub struct Node<'a, T: 'a> { pub data: T, // some fields omitted }
Expand description
A node inside a DOM-like tree.
Fields
data: T
The data held by the node.
Implementations
Create a new node from its associated data.
Typically, this node needs to be moved into an arena allocator before it can be used in a tree.
Return a reference to the parent node, unless this node is the root of the tree.
Return a reference to the first child of this node, unless it has no child.
Return a reference to the last child of this node, unless it has no child.
Return a reference to the previous sibling of this node, unless it is a first child.
Return a reference to the previous sibling of this node, unless it is a last child.
Returns whether two references point to the same node.
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(&'a self) -> PrecedingSiblings<'a, T>ⓘNotable traits for PrecedingSiblings<'a, T>
impl<'a, T> Iterator for PrecedingSiblings<'a, T> type Item = &'a Node<'a, T>;
pub fn preceding_siblings(&'a self) -> PrecedingSiblings<'a, T>ⓘNotable traits for PrecedingSiblings<'a, T>
impl<'a, T> Iterator for PrecedingSiblings<'a, T> type Item = &'a Node<'a, 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(&'a self) -> FollowingSiblings<'a, T>ⓘNotable traits for FollowingSiblings<'a, T>
impl<'a, T> Iterator for FollowingSiblings<'a, T> type Item = &'a Node<'a, T>;
pub fn following_siblings(&'a self) -> FollowingSiblings<'a, T>ⓘNotable traits for FollowingSiblings<'a, T>
impl<'a, T> Iterator for FollowingSiblings<'a, T> type Item = &'a Node<'a, 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.
Return an iterator of references to this node’s children.
pub fn reverse_children(&'a self) -> ReverseChildren<'a, T>ⓘNotable traits for ReverseChildren<'a, T>
impl<'a, T> Iterator for ReverseChildren<'a, T> type Item = &'a Node<'a, T>;
pub fn reverse_children(&'a self) -> ReverseChildren<'a, T>ⓘNotable traits for ReverseChildren<'a, T>
impl<'a, T> Iterator for ReverseChildren<'a, T> type Item = &'a Node<'a, T>;
Return an iterator of references to this node’s children, in reverse order.
pub fn descendants(&'a self) -> Descendants<'a, T>ⓘNotable traits for Descendants<'a, T>
impl<'a, T> Iterator for Descendants<'a, T> type Item = &'a Node<'a, T>;
pub fn descendants(&'a self) -> Descendants<'a, T>ⓘNotable traits for Descendants<'a, T>
impl<'a, T> Iterator for Descendants<'a, T> type Item = &'a Node<'a, 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.
Return an iterator of references to this node and its descendants, in tree order.
pub fn reverse_traverse(&'a self) -> ReverseTraverse<'a, T>ⓘNotable traits for ReverseTraverse<'a, T>
impl<'a, T> Iterator for ReverseTraverse<'a, T> type Item = NodeEdge<&'a Node<'a, T>>;
pub fn reverse_traverse(&'a self) -> ReverseTraverse<'a, T>ⓘNotable traits for ReverseTraverse<'a, T>
impl<'a, T> Iterator for ReverseTraverse<'a, T> type Item = NodeEdge<&'a Node<'a, T>>;
Return an iterator of references to this node and its descendants, in tree order.
Append a new child to this node, after existing children.
Prepend a new child to this node, before existing children.
Insert a new sibling after this node.
Insert a new sibling before this node.
Trait Implementations
A simple Debug implementation that prints the children as a tree, without ilooping through the various interior pointer cycles.
Auto Trait Implementations
impl<'a, T> !RefUnwindSafe for Node<'a, T>
impl<'a, T> !UnwindSafe for Node<'a, T>