Struct Node

Source

pub struct Node<'a, T: 'a> {
    pub data: T,
    /* private fields */
}

Expand description

A node inside a DOM-like tree.

Fields§

§data: T

The data held by the node.

Implementations§

Source §

impl<'a, T> Node<'a, T>

Source

pub 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.

Source

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

Return a reference to the parent node, unless this node is the root of the tree.

Source

pub fn first_child(&self) -> Option<&'a Node<'a, T>>

Return a reference to the first child of this node, unless it has no child.

Source

pub fn last_child(&self) -> Option<&'a Node<'a, T>>

Return a reference to the last child of this node, unless it has no child.

Source

pub 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.

Source

pub fn next_sibling(&self) -> Option<&'a Node<'a, T>>

Return a reference to the next sibling of this node, unless it is a last child.

Source

pub fn same_node(&self, other: &Node<'a, T>) -> bool

Returns whether two references point to the same node.

Source

pub 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.

Source

pub 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.

Source

pub 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.

Source

pub fn children(&'a self) -> Children<'a, T> ⓘ

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

Source

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

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

Source

pub 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.

Similar Functions: Use traverse() or reverse_traverse if you need references to the NodeEdge structs associated with each Node

Source

pub fn traverse(&'a self) -> Traverse<'a, T> ⓘ

Return an iterator of references to NodeEdge enums for each Node and its descendants, in tree order.

NodeEdge enums represent the Start or End of each node.

Similar Functions: Use descendants() if you don’t need Start and End.

Source

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

Return an iterator of references to NodeEdge enums for each Node and its descendants, in reverse order.

NodeEdge enums represent the Start or End of each node.

Similar Functions: Use descendants() if you don’t need Start and End.

Source

pub fn detach(&self)

Detach a node from its parent and siblings. Children are not affected.

Source

pub fn append(&'a self, new_child: &'a Node<'a, T>)

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

Source

pub fn prepend(&'a self, new_child: &'a Node<'a, T>)

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

Source

pub fn insert_after(&'a self, new_sibling: &'a Node<'a, T>)

Insert a new sibling after this node.

Source

pub fn insert_before(&'a self, new_sibling: &'a Node<'a, T>)

Insert a new sibling before this node.

Source §

impl<'a> Node<'a, RefCell<Ast>>

Source

pub fn validate(&'a self) -> Result<(), ValidationError<'a>>

The comrak representation of a markdown node in Rust isn’t strict enough to rule out invalid trees according to the CommonMark specification. One simple example is that block containers, such as lists, should only contain blocks, but it’s possible to put naked inline text in a list item. Such invalid trees can lead comrak to generate incorrect output if rendered.

This method performs additional structural checks to ensure that a markdown AST is valid according to the CommonMark specification.

Note that those invalid trees can only be generated programmatically. Parsing markdown with comrak, on the other hand, should always produce a valid tree.