mdstream 0.2.0

Streaming-first Markdown middleware for LLM output (committed + pending blocks, render-agnostic).
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

mod support;

use mdstream::{FenceBoundaryPlugin, MdStream, Options};

#[test]
fn triple_colon_container_is_single_block() {
    let markdown = "Intro\n\n:::warning\nA\n\nB\n:::\n\nAfter\n";

    let mut s =
        MdStream::new(Options::default()).with_boundary_plugin(FenceBoundaryPlugin::triple_colon());
    let u1 = s.append(markdown);
    let u2 = s.finalize();
    let blocks: Vec<String> = u1
        .committed
        .into_iter()
        .chain(u2.committed)
        .map(|b| b.raw)
        .collect();

    assert_eq!(
        blocks,
        vec![
            "Intro\n\n".to_string(),
            ":::warning\nA\n\nB\n:::\n".to_string(),
            "After\n".to_string(),
        ]
    );
}

#[test]
fn triple_colon_container_chunking_invariance() {
    let markdown = "Intro\n\n:::note\nA\n\nB\n:::\n\nAfter\n";
    let opts = Options::default();

    let blocks_whole = support::collect_final_raw_with_stream(
        support::chunk_whole(markdown),
        MdStream::new(opts.clone()).with_boundary_plugin(FenceBoundaryPlugin::triple_colon()),
    );
    let blocks_lines = support::collect_final_raw_with_stream(
        support::chunk_lines(markdown),
        MdStream::new(opts.clone()).with_boundary_plugin(FenceBoundaryPlugin::triple_colon()),
    );
    let blocks_chars = support::collect_final_raw_with_stream(
        support::chunk_chars(markdown),
        MdStream::new(opts.clone()).with_boundary_plugin(FenceBoundaryPlugin::triple_colon()),
    );
    let blocks_rand = support::collect_final_raw_with_stream(
        support::chunk_pseudo_random(
            markdown,
            "triple_colon_container_chunking_invariance",
            0,
            40,
        ),
        MdStream::new(opts).with_boundary_plugin(FenceBoundaryPlugin::triple_colon()),
    );

    assert_eq!(blocks_lines, blocks_whole);
    assert_eq!(blocks_chars, blocks_whole);
    assert_eq!(blocks_rand, blocks_whole);
}

#[test]
fn reset_clears_boundary_plugin_state() {
    let mut s =
        MdStream::new(Options::default()).with_boundary_plugin(FenceBoundaryPlugin::triple_colon());
    s.append(":::\nA\n");
    s.reset();

    let u = s.append("A\n\nB\n");
    assert_eq!(u.committed.len(), 1);
    assert_eq!(u.committed[0].raw, "A\n\n");
    assert_eq!(u.pending.as_ref().unwrap().raw, "B\n");
}