Enum Block 

pub enum Block {
    Paragraph {
        id: Option<String>,
        children: Vec<Text>,
        attributes: BlockAttributes,
    },
    Heading {
        id: Option<String>,
        level: u8,
        children: Vec<Text>,
        attributes: BlockAttributes,
    },
    List {
        id: Option<String>,
        ordered: bool,
        start: Option<u32>,
        children: Vec<Block>,
        attributes: BlockAttributes,
    },
    ListItem {
        id: Option<String>,
        checked: Option<bool>,
        children: Vec<Block>,
        attributes: BlockAttributes,
    },
    Blockquote {
        id: Option<String>,
        children: Vec<Block>,
        attributes: BlockAttributes,
    },
    CodeBlock {
        id: Option<String>,
        language: Option<String>,
        highlighting: Option<String>,
        tokens: Option<Vec<CodeToken>>,
        children: Vec<Text>,
        attributes: BlockAttributes,
    },
    HorizontalRule {
        id: Option<String>,
    },
    Image(ImageBlock),
    Table {
        id: Option<String>,
        children: Vec<Block>,
        attributes: BlockAttributes,
    },
    TableRow {
        id: Option<String>,
        header: bool,
        children: Vec<Block>,
        attributes: BlockAttributes,
    },
    TableCell(TableCellBlock),
    Math(MathBlock),
    Break {
        id: Option<String>,
    },
    DefinitionList(DefinitionListBlock),
    DefinitionItem {
        id: Option<String>,
        children: Vec<Block>,
        attributes: BlockAttributes,
    },
    DefinitionTerm {
        id: Option<String>,
        children: Vec<Text>,
        attributes: BlockAttributes,
    },
    DefinitionDescription {
        id: Option<String>,
        children: Vec<Block>,
        attributes: BlockAttributes,
    },
    Measurement(MeasurementBlock),
    Signature(SignatureBlock),
    Svg(SvgBlock),
    Barcode(BarcodeBlock),
    Figure(FigureBlock),
    FigCaption(FigCaptionBlock),
    Admonition(AdmonitionBlock),
    Extension(ExtensionBlock),
}

A content block in the document tree.

Blocks are the structural elements of a document, containing either other blocks (containers) or text content (leaves).

Serialization

Blocks serialize as JSON objects with a "type" field. Core block types use camelCase names (e.g., "paragraph", "codeBlock"). Extension blocks use colon-delimited types (e.g., "forms:textInput", "academic:theorem").

Variants

Paragraph

Standard paragraph block.

Fields

id: Option<String>

Optional unique identifier.

children: Vec<Text>

Text content.

attributes: BlockAttributes

Block attributes.

Heading

Section heading (levels 1-6).

Fields

id: Option<String>

Optional unique identifier.

level: u8

Heading level (1-6).

children: Vec<Text>

Text content.

attributes: BlockAttributes

Block attributes.

List

Ordered or unordered list.

Fields

id: Option<String>

Optional unique identifier.

ordered: bool

Whether the list is ordered (numbered).

start: Option<u32>

Starting number for ordered lists.

children: Vec<Block>

List items (must be ListItem blocks).

attributes: BlockAttributes

Block attributes.

ListItem

Item within a list.

Fields

id: Option<String>

Optional unique identifier.

checked: Option<bool>

Checkbox state (None = not a checkbox).

children: Vec<Block>

Block content.

attributes: BlockAttributes

Block attributes.

Blockquote

Quoted content block.

Fields

id: Option<String>

Optional unique identifier.

children: Vec<Block>

Block content.

attributes: BlockAttributes

Block attributes.

CodeBlock

Source code or preformatted text.

Fields

id: Option<String>

Optional unique identifier.

language: Option<String>

Programming language identifier.

highlighting: Option<String>

Syntax highlighting theme.

tokens: Option<Vec<CodeToken>>

Pre-tokenized syntax highlighting.

children: Vec<Text>

Code content (single text node, no marks).

attributes: BlockAttributes

Block attributes.

HorizontalRule

Thematic break between sections.

Fields

id: Option<String>

Optional unique identifier.

Image(ImageBlock)

Embedded or referenced image.

Table

Tabular data.

Fields

id: Option<String>

Optional unique identifier.

children: Vec<Block>

Table rows.

attributes: BlockAttributes

Block attributes.

TableRow

Row within a table.

Fields

id: Option<String>

Optional unique identifier.

header: bool

Whether this is a header row.

children: Vec<Block>

Table cells.

attributes: BlockAttributes

Block attributes.

TableCell(TableCellBlock)

Cell within a table row.

Math(MathBlock)

Mathematical content.

Break

Line break within a block.

Fields

id: Option<String>

Optional unique identifier.

DefinitionList(DefinitionListBlock)

Definition list.

DefinitionItem

Definition item (term + description pair).

Fields

id: Option<String>

Optional unique identifier.

children: Vec<Block>

Children (typically DefinitionTerm and DefinitionDescription).

attributes: BlockAttributes

Block attributes.

DefinitionTerm

Definition term.

Fields

id: Option<String>

Optional unique identifier.

children: Vec<Text>

Term text content.

attributes: BlockAttributes

Block attributes.

DefinitionDescription

Definition description.

Fields

id: Option<String>

Optional unique identifier.

children: Vec<Block>

Description content (blocks).

attributes: BlockAttributes

Block attributes.

Measurement(MeasurementBlock)

Scientific/technical measurement.

Signature(SignatureBlock)

Block-level signature.

Svg(SvgBlock)

SVG image.

Barcode(BarcodeBlock)

Barcode (QR, Data Matrix, etc.).

Figure(FigureBlock)

Figure container.

FigCaption(FigCaptionBlock)

Figure caption.

Admonition(AdmonitionBlock)

Admonition block (note, warning, tip, etc.).

Extension(ExtensionBlock)

Extension block for custom/unknown block types.

Extension blocks use namespaced types like “forms:textInput” or “semantic:citation”. When parsing, unknown types are preserved as extension blocks with their raw attributes intact.

Implementations

impl Block

pub fn paragraph(children: Vec<Text>) -> Self

Create a paragraph block.

pub fn heading(level: u8, children: Vec<Text>) -> Self

Create a heading block.

pub fn unordered_list(items: Vec<Block>) -> Self

Create an unordered list.

pub fn ordered_list(items: Vec<Block>) -> Self

Create an ordered list.

pub fn list_item(children: Vec<Block>) -> Self

Create a list item.

pub fn checkbox(checked: bool, children: Vec<Block>) -> Self

Create a checkbox list item.

pub fn blockquote(children: Vec<Block>) -> Self

Create a blockquote.

pub fn code_block(code: impl Into<String>, language: Option<String>) -> Self

Create a code block.

pub fn horizontal_rule() -> Self

Create a horizontal rule.

pub fn image(src: impl Into<String>, alt: impl Into<String>) -> Self

Create an image block.

pub fn table(rows: Vec<Block>) -> Self

Create a table.

pub fn table_row(cells: Vec<Block>, header: bool) -> Self

Create a table row.

pub fn table_cell(children: Vec<Text>) -> Self

Create a table cell.

pub fn math(value: impl Into<String>, format: MathFormat, display: bool) -> Self

Create a math block.

pub fn line_break() -> Self

Create a line break.

pub fn definition_list(items: Vec<Block>) -> Self

Create a definition list.

pub fn definition_item(children: Vec<Block>) -> Self

Create a definition item.

pub fn definition_term(children: Vec<Text>) -> Self

Create a definition term.

pub fn definition_description(children: Vec<Block>) -> Self

Create a definition description.

pub fn measurement(value: f64, display: impl Into<String>) -> Self

Create a measurement block.

pub fn signature(signature_type: BlockSignatureType) -> Self

Create a signature block.

pub fn svg_from_src(src: impl Into<String>) -> Self

Create an SVG block from a source reference.

pub fn svg_from_content(content: impl Into<String>) -> Self

Create an SVG block from inline content.

pub fn barcode( format: BarcodeFormat, data: impl Into<String>, alt: impl Into<String>, ) -> Self

Create a barcode block.

pub fn figure(children: Vec<Block>) -> Self

Create a figure block.

pub fn figcaption(children: Vec<Text>) -> Self

Create a figure caption.

pub fn admonition(variant: AdmonitionVariant, children: Vec<Block>) -> Self

Create an admonition block.

pub fn block_type(&self) -> Cow<'_, str>

Get the block type as a string.

For core blocks, returns the camelCase type name. For extension blocks, returns the colon-delimited type (e.g., "forms:textInput").

pub fn id(&self) -> Option<&str>

Get the block’s ID if it has one.

pub fn extension( namespace: impl Into<String>, block_type: impl Into<String>, ) -> Self

Create an extension block.

pub fn is_extension(&self) -> bool

Check if this is an extension block.

pub fn as_extension(&self) -> Option<&ExtensionBlock>

Get the extension block if this is one.

Trait Implementations

impl Clone for Block

fn clone(&self) -> Block

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Block

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Block

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for Block

fn eq(&self, other: &Block) -> 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 Serialize for Block

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Block