Struct MarkdownReader 

pub struct MarkdownReader { /* 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::from_str("**bold** and *italic*");
while let Some(event) = reader.next_event()? {
    // Process events...
}

Implementations

impl MarkdownReader

pub fn from_reader<R>(reader: R) -> Result<MarkdownReader, Error>

where R: Read + Seek + Send + 'static,

Creates a MarkdownReader from any Read + Seek source.

Reads the entire source into memory (required by pulldown_cmark’s borrow-based parser).

Errors

Returns Error::Io if reading fails.

pub fn from_str(input: &str) -> MarkdownReader

Creates a MarkdownReader from a string slice.

The input is copied into an owned String for the parser’s lifetime.

Example

use docspec_markdown_reader::MarkdownReader;

let reader = MarkdownReader::from_str("# 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.