Struct Node

pub struct Node {
    pub markdown_node: MarkdownNode,
    pub source_range: Range<usize>,
}

A node in the Markdown AST.

Each Node contains a MarkdownNode variant representing a specific kind of Markdown element (paragraph, heading, code block, etc.), along with a source_range indicating where in the source text this node occurs.

Examples

use basalt_core::markdown::{Node, MarkdownNode, Range, Text};

let node = Node::new(
  MarkdownNode::Paragraph {
    text: Text::default(),
  },
  0..10,
);

assert_eq!(node.markdown_node, MarkdownNode::Paragraph { text: Text::default() });
assert_eq!(node.source_range, Range { start: 0, end: 10 });

Fields

markdown_node: MarkdownNode

The specific Markdown node represented by this node.

source_range: Range<usize>

The range in the original source text that this node covers.

Implementations

impl Node

pub fn new(markdown_node: MarkdownNode, source_range: Range<usize>) -> Self

Creates a new Node from the provided MarkdownNode and source range.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl PartialEq for Node

fn eq(&self, other: &Node) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Node