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
74
75
76
77
78
79
80
81
82
83
84
85

mod support;

use mdstream::{BlockKind, Options};

#[test]
fn streamdown_benchmark_single_code_block() {
    // From Streamdown's parse-blocks benchmark ("single code block").
    let markdown = include_str!("fixtures/streamdown_bench/code_single_code_block.md");

    let opts = Options::default();
    let blocks_whole = support::collect_final_blocks(support::chunk_whole(markdown), opts.clone());
    let blocks_lines = support::collect_final_blocks(support::chunk_lines(markdown), opts.clone());
    let blocks_rand = support::collect_final_blocks(
        support::chunk_pseudo_random(markdown, "streamdown_benchmark_single_code_block", 0, 40),
        opts.clone(),
    );

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

    assert_eq!(blocks_whole.len(), 3);
    assert_eq!(blocks_whole[0].0, BlockKind::Paragraph);
    assert_eq!(blocks_whole[0].1, "Some text\n\n");
    assert_eq!(blocks_whole[1].0, BlockKind::CodeFence);
    assert!(blocks_whole[1].1.contains("```javascript\n"));
    assert!(blocks_whole[1].1.contains("const y = 2;\n"));
    assert!(blocks_whole[1].1.contains("```\n"));
    assert_eq!(blocks_whole[2].0, BlockKind::Paragraph);
    assert_eq!(blocks_whole[2].1, "More text\n");
}

#[test]
fn streamdown_benchmark_multiple_code_blocks() {
    // From Streamdown's parse-blocks benchmark ("multiple code blocks").
    let markdown = include_str!("fixtures/streamdown_bench/code_multiple_code_blocks.md");

    let opts = Options::default();
    let blocks_whole = support::collect_final_blocks(support::chunk_whole(markdown), opts.clone());
    let blocks_lines = support::collect_final_blocks(support::chunk_lines(markdown), opts.clone());
    let blocks_rand = support::collect_final_blocks(
        support::chunk_pseudo_random(markdown, "streamdown_benchmark_multiple_code_blocks", 0, 40),
        opts.clone(),
    );

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

    assert_eq!(blocks_whole.len(), 3);
    assert!(blocks_whole.iter().all(|(k, _)| *k == BlockKind::CodeFence));
    assert!(blocks_whole[0].1.contains("```javascript\n"));
    assert!(blocks_whole[1].1.contains("```python\n"));
    assert!(blocks_whole[2].1.contains("```rust\n"));
}

#[test]
fn streamdown_benchmark_large_code_block_1000_lines() {
    // From Streamdown's parse-blocks benchmark ("large code block (1000 lines)").
    let mut markdown = String::new();
    markdown.push_str("```javascript\n");
    for _ in 0..1000 {
        markdown.push_str("const x = 1;\n");
    }
    markdown.push_str("```");

    let opts = Options::default();
    let blocks_whole = support::collect_final_blocks(support::chunk_whole(&markdown), opts.clone());
    let blocks_lines = support::collect_final_blocks(support::chunk_lines(&markdown), opts.clone());
    let blocks_rand = support::collect_final_blocks(
        support::chunk_pseudo_random(
            &markdown,
            "streamdown_benchmark_large_code_block_1000_lines",
            0,
            40,
        ),
        opts.clone(),
    );

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

    assert_eq!(blocks_whole.len(), 1);
    assert_eq!(blocks_whole[0].0, BlockKind::CodeFence);
    assert!(blocks_whole[0].1.starts_with("```javascript\n"));
    assert!(blocks_whole[0].1.ends_with("```"));
}