Enum Node

pub enum Node {
    Document(Vec<Node>),
    Heading {
        level: u8,
        content: Vec<Node>,
    },
    Paragraph(Vec<Node>),
    BlockQuote(Vec<Node>),
    CodeBlock {
        language: Option<String>,
        content: String,
    },
    UnorderedList(Vec<ListItem>),
    OrderedList {
        start: u32,
        items: Vec<ListItem>,
    },
    ThematicBreak,
    Table {
        headers: Vec<Node>,
        rows: Vec<Vec<Node>>,
        alignments: Vec<Alignment>,
    },
    Link {
        url: String,
        title: Option<String>,
        content: Vec<Node>,
    },
    Image {
        url: String,
        title: Option<String>,
        alt: String,
    },
    Emphasis(Vec<Node>),
    Strong(Vec<Node>),
    InlineCode(String),
    Text(String),
    Html(String),
    SoftBreak,
    HardBreak,
}

Represents a node type in a CommonMark document

Variants

Document(Vec<Node>)

Root document node, containing child nodes

Heading

Heading, containing level (1-6) and content

Fields

level: u8

Heading level, 1-6

content: Vec<Node>

Heading content, containing inline elements

Paragraph(Vec<Node>)

Paragraph node, containing inline elements

BlockQuote(Vec<Node>)

Block quote, containing any block-level elements

CodeBlock

Code block, containing optional language identifier and content

Fields

language: Option<String>

Optional language identifier

content: String

Code content

UnorderedList(Vec<ListItem>)

Unordered list, containing list items

OrderedList

Ordered list, containing starting number and list items

Fields

start: u32

List starting number

items: Vec<ListItem>

List items

ThematicBreak

Thematic break (horizontal rule)

Table

Table

Fields

headers: Vec<Node>

Header cells

rows: Vec<Vec<Node>>

Table rows, each containing multiple cells

alignments: Vec<Alignment>

Column alignments

Link

Link

Fields

url: String

Link URL

title: Option<String>

Optional link title

content: Vec<Node>

Link text content

Image

Image

Fields

url: String

Image URL

title: Option<String>

Optional image title

alt: String

Image alt text

Emphasis(Vec<Node>)

Emphasis (italic)

Strong(Vec<Node>)

Strong emphasis (bold)

InlineCode(String)

Inline code

Text(String)

Plain text

Html(String)

HTML block

SoftBreak

Soft line break (single newline)

HardBreak

Hard line break (two spaces followed by newline or backslash followed by newline)

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 Display 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