codewandler-markdown-stream 0.2.1

Incremental, chunk-safe CommonMark/GFM parser emitting a flat event stream (pure std)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

//! `markdown-stream` — an incremental, streaming CommonMark/GFM parser.
//!
//! Pure `std`, no runtime dependencies. Feed bytes to a [`StreamParser`] with [`Parser::write`] and
//! consume the flat [`Event`] stream it emits; call [`Parser::flush`] at end of input. The event
//! stream is **independent of how the input is chunked** (split-equivalence) — this is what makes
//! the parser usable on a live token stream from an LLM.
//!
//! The parser is *append-only and chunk-safe*; renderers (`markdown-html`, `markdown-terminal`)
//! consume the events and never re-parse Markdown.

#![forbid(unsafe_code)]

mod block;
mod entity;
mod event;
mod inline;
mod linkref;
mod parser;

pub use block::StreamParser;
pub use event::{
    Alignment, BlockData, BlockKind, Event, Inline, InlineStyle, Link, ListData, Span,
};
pub use parser::Parser;

/// Parse a complete document to a `Vec<Event>` (convenience over the streaming API).
pub fn parse(input: &str) -> Vec<Event> {
    let mut p = StreamParser::new();
    let mut events = p.write(input.as_bytes());
    events.extend(p.flush());
    events
}

/// Parse a complete document with GFM-only extensions enabled (extended autolinks, task-list items),
/// in addition to the always-on strikethrough and tables.
pub fn parse_gfm(input: &str) -> Vec<Event> {
    let mut p = StreamParser::new_gfm();
    let mut events = p.write(input.as_bytes());
    events.extend(p.flush());
    events
}