Skip to main content

Event

Enum Event 

Source
pub enum Event {
    EnterBlock {
        block: BlockKind,
        data: BlockData,
        span: Span,
    },
    ExitBlock {
        block: BlockKind,
        span: Span,
    },
    Text {
        text: String,
        style: InlineStyle,
        span: Span,
    },
    EnterInline {
        inline: Inline,
        span: Span,
    },
    ExitInline {
        inline: Inline,
    },
    SoftBreak,
    LineBreak,
}
Expand description

One parser event. The stream is a depth-first walk: every EnterBlock is eventually balanced by an ExitBlock of the same kind.

Variants§

§

EnterBlock

Fields

§span: Span
§

ExitBlock

Fields

§span: Span
§

Text

A run of inline text with its accumulated styling.

Fields

§text: String
§span: Span
§

EnterInline

Open an inline span (emphasis, strong, link, …). Balanced by a matching ExitInline.

Fields

§inline: Inline
§span: Span
§

ExitInline

Close the most recently opened inline span of the matching inline.

Fields

§inline: Inline
§

SoftBreak

A newline within a paragraph (rendered as a space / \n in HTML).

§

LineBreak

A hard line break (two trailing spaces or a backslash).

Implementations§

Source§

impl Event

Source

pub fn text(s: impl Into<String>) -> Event

Convenience constructor for a plain (unstyled) text event.

Source

pub fn enter(block: BlockKind) -> Event

Convenience constructor for an EnterBlock with default data.

Source

pub fn exit(block: BlockKind) -> Event

Convenience constructor for an ExitBlock.

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Event

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 Event

Source§

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

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

impl Eq for Event

Source§

impl PartialEq for Event

Source§

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

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

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.