Enum BlockNode 

#[non_exhaustive]
pub enum BlockNode {
    Root {
        children: Vec<BlockNode>,
        span: Option<Span>,
    },
    Paragraph(Paragraph),
    Heading {
        level: u8,
        children: Paragraph,
        span: Option<Span>,
    },
    Blockquote {
        children: Vec<BlockNode>,
        span: Option<Span>,
    },
    Surface {
        name: SharedString,
        children: Vec<BlockNode>,
        span: Option<Span>,
    },
    List {
        children: Vec<BlockNode>,
        ordered: bool,
        start: Option<u32>,
        span: Option<Span>,
    },
    ListItem {
        children: Vec<BlockNode>,
        spread: bool,
        checked: Option<bool>,
        task_marker: Option<Span>,
        span: Option<Span>,
    },
    CodeBlock(CodeBlock),
    Custom {
        node: MarkdownNode,
        state: BlockState,
    },
    Table(Table),
    Break {
        html: bool,
        span: Option<Span>,
    },
    HorizontalRule {
        span: Option<Span>,
    },
    Definition {
        identifier: SharedString,
        url: SharedString,
        title: Option<SharedString>,
        span: Option<Span>,
    },
    Unknown,
}

The block-level nodes.

This is the document tree TextView renders. Together with editor_host it is also the hand-over type for external editors: they build the tree, render it with BlockNode::render and read geometry back per leaf.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Root

Something like a Div container in HTML.

Fields

children: Vec<BlockNode>

span: Option<Span>

Paragraph(Paragraph)

Heading

Fields

level: u8

children: Paragraph

span: Option<Span>

Blockquote

Fields

children: Vec<BlockNode>

span: Option<Span>

Surface

A blockquote opening with the marker of a block surface, drawn inside the container registered for name.

Its text, selection, highlights and reveals are its children’s, which leave out the marker line.

Fields

name: SharedString

The name it is registered under, in ASCII lowercase.

children: Vec<BlockNode>

span: Option<Span>

The source of the whole blockquote, marker included.

List

Fields

children: Vec<BlockNode>

Only contains ListItem, others will be ignored

ordered: bool

start: Option<u32>

The first ordinal for an ordered list. HTML lists leave this unset.

span: Option<Span>

ListItem

Fields

children: Vec<BlockNode>

spread: bool

checked: Option<bool>

Whether the list item is checked, if None, it’s not a checkbox

task_marker: Option<Span>

The source of a Markdown task item’s [ ] / [x] marker.

span: Option<Span>

CodeBlock(CodeBlock)

Custom

A custom Markdown node produced by MarkdownExtensions.

Fields

node: MarkdownNode

state: BlockState

Table(Table)

Break

Fields

html: bool

span: Option<Span>

HorizontalRule

Fields

span: Option<Span>

Definition

Use for to_markdown get raw definition

Fields

identifier: SharedString

url: SharedString

title: Option<SharedString>

span: Option<Span>

Unknown

Implementations

impl BlockNode

pub fn render_with_id( &self, id: impl Into<ElementId>, flow: FlowPosition, render_context: &RenderContext, window: &mut Window, cx: &mut App, ) -> AnyElement

Renders under a stable host-owned identity. Use a domain ID, not a list position, when inserting, reordering or virtualizing blocks. Identity scopes GPUI element state independently of the leaf keys used for geometry.

pub fn render( &self, ix: usize, flow: FlowPosition, cx: &RenderContext, window: &mut Window, app: &mut App, ) -> AnyElement

Renders the block as TextView does. ix identifies the block among its siblings (element ids derive from it).

impl BlockNode

pub fn span(&self) -> Option<Span>

Get the span of the node.

Trait Implementations

impl Clone for BlockNode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockNode

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

Formats the value using the given formatter.

impl PartialEq for BlockNode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BlockNode