Enum readme_sync::CMarkItem

pub enum CMarkItem {
    Parsed {
        event: Event<'static>,
        range: Range<usize>,
        text_source: TextSource,
    },
    Created {
        event: Event<'static>,
        note: Cow<'static, str>,
    },
    Modified {
        event: Event<'static>,
        nodes: Box<[Arc<CMarkItem>]>,
        note: Cow<'static, str>,
    },
    Removed {
        nodes: Box<[Arc<CMarkItem>]>,
        note: Cow<'static, str>,
    },
    Noted {
        node: Arc<CMarkItem>,
        note: Cow<'static, str>,
    },
}

An enum that store Markdown event, its origin, and modifications. The event modification tree is stored to improve error messages.

Variants

Parsed

A Markdown event parsed from the specified text source.

Fields of Parsed

event: Event<'static>

Parsed Markdown event.

range: Range<usize>

The corresponding range of the event in the source text.

text_source: TextSource

Text source.

Created

A Markdown event created by data transform functions.

Fields of Created

event: Event<'static>

Created Markdown event.

note: Cow<'static, str>

Data transformation note.

Modified

A Markdown event created from other Markdown events.

Fields of Modified

event: Event<'static>

A Markdown event created from other events.

nodes: Box<[Arc<CMarkItem>]>

Source CMarkItems.

note: Cow<'static, str>

Data transformation note.

Removed

A removed Markdown events.

Fields of Removed

nodes: Box<[Arc<CMarkItem>]>

Removed CMarkItems.

note: Cow<'static, str>

Data transformation note.

Noted

A non-modified Markdown event that noted by data transform function.

Fields of Noted

node: Arc<CMarkItem>

Noted CMarkItem.

note: Cow<'static, str>

Data transformation note.

Implementations

impl<'a> CMarkItem

pub fn new(event: Event<'static>, note: Cow<'static, str>) -> Arc<Self>

Creates CMarkItem with the specified Event and its note.

pub fn from(
    event: Event<'static>,
    range: Range<usize>,
    text_source: TextSource
) -> Arc<Self>

Creates CMarkItem as an event parsed from the specified text source range.

pub fn event(&self) -> Option<&Event<'static>>

Returns the event or None if it is removed.

pub fn spans(&self) -> Vec<CMarkSpan<'_>>

Returns a Vec of event spans.

Trait Implementations

impl Clone for CMarkItem

pub fn clone(&self) -> CMarkItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CMarkItem

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

Formats the value using the given formatter.

impl PartialEq<CMarkItem> for CMarkItem

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

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

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

This method tests for !=.

impl StructuralPartialEq for CMarkItem