Struct MarkdownReader 

pub struct MarkdownReader<'a> { /* private fields */ }

Available on crate feature markdown only.

Streaming Markdown reader. Available when the markdown feature is enabled. A streaming Markdown reader that implements EventSource.

MarkdownReader parses Markdown using pulldown-cmark and emits DocSpec events one at a time. It handles the mapping from pulldown-cmark’s event model to DocSpec’s event model, including tracking inline formatting state.

Example

use docspec_markdown_reader::{MarkdownReader, EventSource};

let mut reader = MarkdownReader::new("**bold** and *italic*");
while let Some(event) = reader.next_event()? {
    // Process events...
}

Implementations

impl<'a> MarkdownReader<'a>

pub fn new(markdown: &'a str) -> MarkdownReader<'a>

Creates a new MarkdownReader from the given Markdown string.

The reader will emit StartDocument as its first event and EndDocument as its last event, with the parsed content events in between.

Example

use docspec_markdown_reader::MarkdownReader;

let reader = MarkdownReader::new("# Hello World");

Trait Implementations

impl EventSource for MarkdownReader<'_>

fn next_event(&mut self) -> Result<Option<Event>, Error>

Returns the next event from the stream, or None if the stream has ended.