Enum jotdown::Event

pub enum Event<'s> {
    Start(Container<'s>, Attributes<'s>),
    End(Container<'s>),
    Str(Cow<'s, str>),
    FootnoteReference(&'s str, usize),
    Symbol(Cow<'s, str>),
    LeftSingleQuote,
    RightSingleQuote,
    LeftDoubleQuote,
    RightDoubleQuote,
    Ellipsis,
    EnDash,
    EmDash,
    NonBreakingSpace,
    Softbreak,
    Hardbreak,
    Escape,
    Blankline,
    ThematicBreak(Attributes<'s>),
}

A Djot event.

A Djot document is represented by a sequence of events. An element may consist of one or multiple events. Container elements are represented by a Event::Start followed by events representing its content, and finally a Event::End. Atomic elements without any inside elements are represented by a single event.

Variants

Start(Container<'s>, Attributes<'s>)

Start of a container.

End(Container<'s>)

End of a container.

Str(Cow<'s, str>)

A string object, text only.

FootnoteReference(&'s str, usize)

A footnote reference.

Symbol(Cow<'s, str>)

A symbol, by default rendered literally but may be treated specially.

LeftSingleQuote

Left single quotation mark.

RightSingleQuote

Right double quotation mark.

LeftDoubleQuote

Left single quotation mark.

RightDoubleQuote

Right double quotation mark.

Ellipsis

A horizontal ellipsis, i.e. a set of three periods.

EnDash

An en dash.

EmDash

An em dash.

NonBreakingSpace

A space that must not break a line.

Softbreak

A newline that may or may not break a line in the output.

Hardbreak

A newline that must break a line in the output.

Escape

An escape character, not visible in output.

Blankline

A blank line, not visible in output.

ThematicBreak(Attributes<'s>)

A thematic break, typically a horizontal rule.

Trait Implementations

impl<'s> Debug for Event<'s>

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

Formats the value using the given formatter.

impl<'s> PartialEq<Event<'s>> for Event<'s>

fn eq(&self, other: &Event<'s>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'s> Eq for Event<'s>

impl<'s> StructuralEq for Event<'s>

impl<'s> StructuralPartialEq for Event<'s>