Struct markdown_it::Node

pub struct Node {
    pub children: Vec<Node>,
    pub srcmap: Option<SourcePos>,
    pub ext: NodeExtSet,
    pub attrs: Vec<(&'static str, String)>,
    pub node_type: TypeKey,
    pub node_value: Box<dyn NodeValue>,
}

Single node in the CommonMark AST.

Fields

children: Vec<Node>

Array of child nodes.

srcmap: Option<SourcePos>

Source mapping info.

ext: NodeExtSet

Custom data specific to this token.

attrs: Vec<(&'static str, String)>

Additional attributes to be added to resulting html.

node_type: TypeKey

Type name, used for debugging.

node_value: Box<dyn NodeValue>

Storage for arbitrary token-specific data.

Implementations

impl Node

pub fn new<T: NodeValue>(value: T) -> Self

Create a new Node with a custom value.

pub fn name(&self) -> &'static str

Return std::any::type_name() of node value.

pub fn is<T: NodeValue>(&self) -> bool

Check that this node value is of given type.

pub fn cast<T: NodeValue>(&self) -> Option<&T>

Downcast node value to specific type.

pub fn cast_mut<T: NodeValue>(&mut self) -> Option<&mut T>

Downcast node value to specific type.

pub fn render(&self) -> String

Render this node to HTML.

pub fn xrender(&self) -> String

Render this node to XHTML, it adds slash to self-closing tags like this: <img />.

This mode exists for compatibility with CommonMark tests.

pub fn replace<T: NodeValue>(&mut self, value: T)

Replace custom value with another value (this is roughly equivalent to replacing the entire node and copying children and sourcemaps).

pub fn walk(&self, f: impl FnMut(&Node, u32))

Execute function f recursively on every member of AST tree (using preorder deep-first search).

pub fn walk_mut(&mut self, f: impl FnMut(&mut Node, u32))

Execute function f recursively on every member of AST tree (using preorder deep-first search).

pub fn walk_post(&self, f: impl FnMut(&Node, u32))

Execute function f recursively on every member of AST tree (using postorder deep-first search).

pub fn walk_post_mut(&mut self, f: impl FnMut(&mut Node, u32))

Execute function f recursively on every member of AST tree (using postorder deep-first search).

Trait Implementations

impl Debug for Node

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

Formats the value using the given formatter.

impl Default for Node

fn default() -> Self

Create empty Node. Empty node should only be used as placeholder for functions like std::mem::take, and it cannot be rendered.

impl Drop for Node

fn drop(&mut self)

Executes the destructor for this type.