Skip to main content

Block

Enum Block 

Source
pub enum Block {
Show 19 variants Paragraph(Paragraph), Heading(Heading), ThematicBreak(ThematicBreak), BlockQuote(BlockQuote), Alert(Alert), List(List), DescriptionList(DescriptionList), CodeBlock(CodeBlock), HtmlBlock(HtmlBlock), Definition(Definition), FootnoteDefinition(FootnoteDefinition), Table(Table), MathBlock(MathBlock), Frontmatter(Frontmatter), MdxEsm(MdxEsm), MdxExpression(MdxExpression), MdxJsx(MdxJsx), LeafDirective(LeafDirective), ContainerDirective(ContainerDirective),
}
Expand description

A block-level node: the building blocks of a document’s vertical structure.

Variants§

§

Paragraph(Paragraph)

A paragraph of inline content.

§

Heading(Heading)

An ATX (# h) or setext (underlined) heading.

§

ThematicBreak(ThematicBreak)

A thematic break / horizontal rule: ---, ***, or ___.

§

BlockQuote(BlockQuote)

A block quote: lines prefixed with > .

§

Alert(Alert)

A GFM alert / admonition: > [!NOTE] etc.

§

List(List)

A bullet or ordered list.

§

DescriptionList(DescriptionList)

A description / definition list (term + details).

§

CodeBlock(CodeBlock)

A fenced (```) or indented code block.

§

HtmlBlock(HtmlBlock)

A raw HTML block.

§

Definition(Definition)

A link reference definition: [label]: url "title".

§

FootnoteDefinition(FootnoteDefinition)

A footnote definition: [^id]: text.

§

Table(Table)

A GFM pipe table.

§

MathBlock(MathBlock)

A display math block: $$ … $$.

§

Frontmatter(Frontmatter)

A leading frontmatter block (--- YAML or +++ TOML).

§

MdxEsm(MdxEsm)

An MDX ESM block (import/export statements).

§

MdxExpression(MdxExpression)

A block-level MDX expression: { … }.

§

MdxJsx(MdxJsx)

A block-level MDX JSX element.

§

LeafDirective(LeafDirective)

A leaf directive: ::name[label]{attrs} (distinct from MDX).

§

ContainerDirective(ContainerDirective)

A container directive: :::name … ::: (distinct from MDX).

Implementations§

Source§

impl Block

Source

pub fn meta(&self) -> &NodeMeta

Borrow this node’s NodeMeta.

Source

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

This node’s source span, if it carries one.

Trait Implementations§

Source§

impl Clone for Block

Source§

fn clone(&self) -> Block

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Block

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Block

Source§

impl From<Alert> for Block

Source§

fn from(node: Alert) -> Self

Converts to this type from the input type.
Source§

impl From<BlockQuote> for Block

Source§

fn from(node: BlockQuote) -> Self

Converts to this type from the input type.
Source§

impl From<CodeBlock> for Block

Source§

fn from(node: CodeBlock) -> Self

Converts to this type from the input type.
Source§

impl From<ContainerDirective> for Block

Source§

fn from(node: ContainerDirective) -> Self

Converts to this type from the input type.
Source§

impl From<Definition> for Block

Source§

fn from(node: Definition) -> Self

Converts to this type from the input type.
Source§

impl From<DescriptionList> for Block

Source§

fn from(node: DescriptionList) -> Self

Converts to this type from the input type.
Source§

impl From<FootnoteDefinition> for Block

Source§

fn from(node: FootnoteDefinition) -> Self

Converts to this type from the input type.
Source§

impl From<Frontmatter> for Block

Source§

fn from(node: Frontmatter) -> Self

Converts to this type from the input type.
Source§

impl From<Heading> for Block

Source§

fn from(node: Heading) -> Self

Converts to this type from the input type.
Source§

impl From<HtmlBlock> for Block

Source§

fn from(node: HtmlBlock) -> Self

Converts to this type from the input type.
Source§

impl From<LeafDirective> for Block

Source§

fn from(node: LeafDirective) -> Self

Converts to this type from the input type.
Source§

impl From<List> for Block

Source§

fn from(node: List) -> Self

Converts to this type from the input type.
Source§

impl From<MathBlock> for Block

Source§

fn from(node: MathBlock) -> Self

Converts to this type from the input type.
Source§

impl From<MdxEsm> for Block

Source§

fn from(node: MdxEsm) -> Self

Converts to this type from the input type.
Source§

impl From<MdxExpression> for Block

Source§

fn from(node: MdxExpression) -> Self

Converts to this type from the input type.
Source§

impl From<MdxJsx> for Block

Source§

fn from(node: MdxJsx) -> Self

Converts to this type from the input type.
Source§

impl From<Paragraph> for Block

Source§

fn from(node: Paragraph) -> Self

Converts to this type from the input type.
Source§

impl From<Table> for Block

Source§

fn from(node: Table) -> Self

Converts to this type from the input type.
Source§

impl From<ThematicBreak> for Block

Source§

fn from(node: ThematicBreak) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Block

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Block

Auto Trait Implementations§

§

impl Freeze for Block

§

impl RefUnwindSafe for Block

§

impl Send for Block

§

impl Sync for Block

§

impl Unpin for Block

§

impl UnsafeUnpin for Block

§

impl UnwindSafe for Block

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.