Struct comrak::Node
[−]
[src]
pub struct Node<'a, T: 'a> {
pub data: T,
// some fields omitted
}A node inside a DOM-like tree.
Fields
data: T
Methods
impl<'a, T> Node<'a, T>[src]
fn new(data: T) -> Node<'a, T>
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.
fn parent(&self) -> Option<&'a Node<'a, T>>
Return a reference to the parent node, unless this node is the root of the tree.
fn first_child(&self) -> Option<&'a Node<'a, T>>
Return a reference to the first child of this node, unless it has no child.
fn last_child(&self) -> Option<&'a Node<'a, T>>
Return a reference to the last child of this node, unless it has no child.
fn previous_sibling(&self) -> Option<&'a Node<'a, T>>
Return a reference to the previous sibling of this node, unless it is a first child.
fn next_sibling(&self) -> Option<&'a Node<'a, T>>
Return a reference to the previous sibling of this node, unless it is a last child.
fn same_node(&self, other: &Node<'a, T>) -> bool
Returns whether two references point to the same node.
fn ancestors(&'a self) -> Ancestors<'a, T>
Return an iterator of references to this node and its ancestors.
Call .next().unwrap() once on the iterator to skip the node itself.
fn preceding_siblings(&'a self) -> PrecedingSiblings<'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.
fn following_siblings(&'a self) -> FollowingSiblings<'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.
fn children(&'a self) -> Children<'a, T>
Return an iterator of references to this node’s children.
fn reverse_children(&'a self) -> ReverseChildren<'a, T>
Return an iterator of references to this node’s children, in reverse order.
fn descendants(&'a self) -> Descendants<'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.
fn traverse(&'a self) -> Traverse<'a, T>
Return an iterator of references to this node and its descendants, in tree order.
fn reverse_traverse(&'a self) -> ReverseTraverse<'a, T>
Return an iterator of references to this node and its descendants, in tree order.
fn detach(&self)
Detach a node from its parent and siblings. Children are not affected.
fn append(&'a self, new_child: &'a Node<'a, T>)
Append a new child to this node, after existing children.
fn prepend(&'a self, new_child: &'a Node<'a, T>)
Prepend a new child to this node, before existing children.
fn insert_after(&'a self, new_sibling: &'a Node<'a, T>)
Insert a new sibling after this node.
fn insert_before(&'a self, new_sibling: &'a Node<'a, T>)
Insert a new sibling before this node.