Skip to main content

BlockEvent

Enum BlockEvent 

Source
pub enum BlockEvent {
Show 40 variants ParagraphStart, ParagraphEnd, HeadingStart { level: u8, }, HeadingEnd { level: u8, }, CodeBlockStart { kind: CodeBlockKind, }, CodeBlockEnd, BlockQuoteStart { callout: Option<CalloutType>, }, BlockQuoteEnd, ListStart { kind: ListKind, tight: bool, }, ListEnd { kind: ListKind, tight: bool, }, ListItemStart { task: TaskState, }, ListItemEnd, DefinitionListStart, DefinitionListEnd, DefinitionTermStart, DefinitionTermEnd, DefinitionDescriptionStart { tight: bool, }, DefinitionDescriptionEnd, ThematicBreak(Range), Comment(Range), HtmlBlockStart, HtmlBlockEnd, HtmlBlockText(Range), SoftBreak, Text(Range), Code(Range), VirtualSpaces(u8), TableStart, TableColumnWidthsStart, TableColumnWidth { basis_points: u16, }, TableColumnWidthsEnd, TableEnd, TableHeadStart, TableHeadEnd, TableBodyStart, TableBodyEnd, TableRowStart, TableRowEnd, TableCellStart { alignment: Alignment, colspan: u16, }, TableCellEnd,
}
Expand description

Events emitted by the block parser.

Variants§

§

ParagraphStart

Start of a paragraph.

§

ParagraphEnd

End of a paragraph.

§

HeadingStart

Start of a heading.

Fields

§level: u8

Heading level (1-6).

§

HeadingEnd

End of a heading.

Fields

§level: u8

Heading level (1-6).

§

CodeBlockStart

Start of a code block.

Fields

§kind: CodeBlockKind

Whether the block is fenced or indented.

§

CodeBlockEnd

End of a code block.

§

BlockQuoteStart

Start of a blockquote (possibly a callout/admonition).

Fields

§callout: Option<CalloutType>

Callout type, if this blockquote starts with [!TYPE].

§

BlockQuoteEnd

End of a blockquote.

§

ListStart

Start of a list.

Fields

§kind: ListKind

List type (ordered or unordered).

§tight: bool

Whether the list is tight (no blank lines between items).

§

ListEnd

End of a list.

Fields

§kind: ListKind

List type (ordered or unordered).

§tight: bool

Whether the list is tight.

§

ListItemStart

Start of a list item.

Fields

§task: TaskState

Task state for task list items.

§

ListItemEnd

End of a list item.

§

DefinitionListStart

Start of a definition list.

§

DefinitionListEnd

End of a definition list.

§

DefinitionTermStart

Start of a definition term.

§

DefinitionTermEnd

End of a definition term.

§

DefinitionDescriptionStart

Start of a definition description.

Fields

§tight: bool

Whether the first paragraph should omit its <p> wrapper.

§

DefinitionDescriptionEnd

End of a definition description.

§

ThematicBreak(Range)

A thematic break (horizontal rule).

The Range covers the marker run and any intervening or trailing horizontal whitespace on the same line. It excludes container indentation (leading spaces already consumed by the block loop) and the line ending character.

§

Comment(Range)

A source-only line comment omitted by the HTML renderer.

§

HtmlBlockStart

Start of an HTML block.

§

HtmlBlockEnd

End of an HTML block.

§

HtmlBlockText(Range)

Raw HTML block content (not to be inline-parsed or escaped).

§

SoftBreak

Soft line break (newline within paragraph).

§

Text(Range)

Inline content range to be parsed by the inline parser.

§

Code(Range)

Raw code content (not to be inline-parsed).

§

VirtualSpaces(u8)

Virtual spaces to prepend to code content (from tab expansion). This event is followed by a Code or Text event.

§

TableStart

Start of a table.

§

TableColumnWidthsStart

Start of relative column-width hints for a table.

§

TableColumnWidth

A numeric table column-width hint in hundredths of one percent.

Fields

§basis_points: u16

Width in basis points (2500 means 25%).

§

TableColumnWidthsEnd

End of relative column-width hints for a table.

§

TableEnd

End of a table.

§

TableHeadStart

Start of a table header section.

§

TableHeadEnd

End of a table header section.

§

TableBodyStart

Start of a table body section.

§

TableBodyEnd

End of a table body section.

§

TableRowStart

Start of a table row.

§

TableRowEnd

End of a table row.

§

TableCellStart

Start of a table cell with alignment.

Fields

§alignment: Alignment

Column alignment for this cell.

§colspan: u16

Number of source columns covered by this cell.

§

TableCellEnd

End of a table cell.

Trait Implementations§

Source§

impl Clone for BlockEvent

Source§

fn clone(&self) -> BlockEvent

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 BlockEvent

Source§

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

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

impl Eq for BlockEvent

Source§

impl PartialEq for BlockEvent

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BlockEvent

Auto Trait Implementations§

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.