Enum Node 

pub enum Node {
    Paragraph {
        children: Vec<Node>,
    },
    Heading {
        level: u8,
        children: Vec<Node>,
    },
    BulletList {
        items: Vec<Node>,
    },
    OrderedList {
        start: u32,
        items: Vec<Node>,
    },
    ListItem {
        checked: Option<bool>,
        children: Vec<Node>,
    },
    Table {
        align: Vec<Align>,
        rows: Vec<Vec<TableCell>>,
    },
    BlockQuote {
        children: Vec<Node>,
    },
    ThematicBreak,
    CodeBlock {
        lang: Option<String>,
        code: String,
    },
    Code {
        code: String,
    },
    Emphasis {
        children: Vec<Node>,
    },
    Strong {
        children: Vec<Node>,
    },
    Strikethrough {
        children: Vec<Node>,
    },
    Link {
        href: String,
        children: Vec<Node>,
    },
    Image {
        src: String,
        alt: String,
    },
    SoftBreak,
    LineBreak,
    Text {
        value: String,
    },
}

One node of parsed markdown.

Shaped for a client to walk and turn into DOM nodes directly — every variant is either a container (children, or for a list or table, a nested collection) or a leaf that carries exactly the data needed to build one element. There is no HTML anywhere in this type; see the module documentation for the two places that turn attacker-controlled markup into plain Node::Text instead of a live link or image.

Variants

Paragraph

A paragraph.

Fields

children: Vec<Node>

Inline content.

Heading

A heading.

Fields

level: u8

Heading level, 1 through 6.

children: Vec<Node>

Inline content.

BulletList

An unordered (bullet) list.

Fields

items: Vec<Node>

The list’s items. Always Node::ListItem.

OrderedList

An ordered (numbered) list.

Fields

start: u32

The number the list starts counting from.

items: Vec<Node>

The list’s items. Always Node::ListItem.

ListItem

One item of a list, or of a GFM task list.

Fields

checked: Option<bool>

Some(true) for a checked task item, Some(false) for an unchecked one, None for a plain list item.

children: Vec<Node>

The item’s block content, which may include a nested list.

Table

A GFM table.

Fields

align: Vec<Align>

One alignment per column, in column order.

rows: Vec<Vec<TableCell>>

Rows in reading order; the first is the header row.

BlockQuote

A block quote.

Fields

children: Vec<Node>

The quote’s block content.

ThematicBreak

A horizontal rule (---).

CodeBlock

A fenced or indented code block.

Never syntax-highlighted: magi does not add a highlighting dependency, so lang is carried only as a label for the client to show, not as a hint the server has already acted on.

Fields

lang: Option<String>

The fence’s info string (e.g. rust), if the source gave one.

code: String

The block’s literal text.

Code

An inline code span.

Fields

code: String

The span’s literal text.

Emphasis

Emphasized (*italic*) inline content.

Fields

children: Vec<Node>

Inline content.

Strong

Strongly emphasized (**bold**) inline content.

Fields

children: Vec<Node>

Inline content.

Strikethrough

Struck-through (~~text~~) inline content.

Fields

children: Vec<Node>

Inline content.

Link

A link. Only ever produced for an http:/https: destination; any other scheme becomes Node::Text instead, see [normalize_link].

Fields

href: String

The link’s destination.

children: Vec<Node>

The link’s inline text.

Image

An image. Only ever produced for a data: image URI or a resolved question panel asset; anything else becomes Node::Text instead, see [normalize_image].

Fields

src: String

The image’s resolved source.

alt: String

The image’s alt text.

SoftBreak

A soft line break: a single newline in the source, conventionally rendered as a space or an ordinary wrap.

LineBreak

A hard line break: two trailing spaces, or a trailing backslash, in the source.

Text

Plain text.

Also stands in for anything to_nodes refuses to render as markup: raw HTML from the source, a link with a disallowed scheme, an image with a disallowed source.

Fields

value: String

The text itself.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a duplicate 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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Node

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Node