Enum Event

pub enum Event<'a> {
    Start(Tag<'a>),
    End(TagEnd),
    Text(CowStr<'a>),
    Code(CowStr<'a>),
    InlineMath(CowStr<'a>),
    DisplayMath(CowStr<'a>),
    Html(CowStr<'a>),
    InlineHtml(CowStr<'a>),
    FootnoteReference(CowStr<'a>),
    SoftBreak,
    HardBreak,
    Rule,
    TaskListMarker(bool),
}

Markdown events that are generated in a preorder traversal of the document tree, with additional End events whenever all of an inner node’s children have been visited.

Variants

Start(Tag<'a>)

Start of a tagged element. Events that are yielded after this event and before its corresponding End event are inside this element. Start and end events are guaranteed to be balanced.

End(TagEnd)

End of a tagged element.

Text(CowStr<'a>)

A text node.

All text, outside and inside Tags.

Code(CowStr<'a>)

An inline code node.

`code`

InlineMath(CowStr<'a>)

An inline math environment node. Requires Options::ENABLE_MATH.

$math$

DisplayMath(CowStr<'a>)

A display math environment node. Requires Options::ENABLE_MATH.

$$math$$

Html(CowStr<'a>)

An HTML node.

A line of HTML inside Tag::HtmlBlock includes the line break.

InlineHtml(CowStr<'a>)

An inline HTML node.

Contains only the tag itself, e.g. <open-tag>, </close-tag> or <!-- comment -->.

Note: Under some conditions HTML can also be parsed as an HTML Block, see Tag::HtmlBlock for details.

FootnoteReference(CowStr<'a>)

A reference to a footnote with given label, which may or may not be defined by an event with a Tag::FootnoteDefinition tag. Definitions and references to them may occur in any order. Only parsed and emitted with Options::ENABLE_FOOTNOTES or Options::ENABLE_OLD_FOOTNOTES.

[^1]

SoftBreak

A soft line break.

Any line break that isn’t a HardBreak, or the end of e.g. a paragraph.

HardBreak

A hard line break.

A line ending that is either preceded by at least two spaces or \.

hard··
line\
breaks

· is a space

Rule

A horizontal ruler.

***
···---
_·_··_····_··

· is any whitespace

TaskListMarker(bool)

A task list marker, rendered as a checkbox in HTML. Contains a true when it is checked. Only parsed and emitted with Options::ENABLE_TASKLISTS.

- [ ] unchecked
- [x] checked

Implementations

impl<'a> Event<'a>

pub fn into_static(self) -> Event<'static>

Trait Implementations

impl<'a> Clone for Event<'a>

fn clone(&self) -> Event<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Event<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Event<'a>

fn eq(&self, other: &Event<'a>) -> 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<'a> StructuralPartialEq for Event<'a>