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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

use std::sync::Arc;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};

mod support;

use mdstream::{BoundaryUpdate, FnBoundaryPlugin, MdStream, Options};

#[test]
fn fn_boundary_plugin_can_model_a_custom_fence() {
    let started = Arc::new(AtomicUsize::new(0));
    let just_started = Arc::new(AtomicBool::new(false));

    let started_for_start = started.clone();
    let just_started_for_start = just_started.clone();
    let just_started_for_update = just_started.clone();

    let plugin = FnBoundaryPlugin::new(
        |line| line.trim() == "@@@",
        move |line| {
            if just_started_for_update.swap(false, Ordering::SeqCst) {
                return BoundaryUpdate::Continue;
            }
            if line.trim() == "@@@" {
                BoundaryUpdate::Close
            } else {
                BoundaryUpdate::Continue
            }
        },
    )
    .with_start(move |_| {
        started_for_start.fetch_add(1, Ordering::SeqCst);
        just_started_for_start.store(true, Ordering::SeqCst);
    })
    .with_reset({
        let just_started = just_started.clone();
        move || {
            just_started.store(false, Ordering::SeqCst);
        }
    });

    let markdown = "Intro\n\n@@@\nA\n\nB\n@@@\n\nAfter\n";
    let blocks = support::collect_final_raw_with_stream(
        support::chunk_whole(markdown),
        MdStream::new(Options::default()).with_boundary_plugin(plugin),
    );
    assert_eq!(
        blocks,
        vec![
            "Intro\n\n".to_string(),
            "@@@\nA\n\nB\n@@@\n".to_string(),
            "After\n".to_string(),
        ]
    );
    assert_eq!(started.load(Ordering::SeqCst), 1);
}

#[test]
fn fn_boundary_plugin_chunking_invariance() {
    let just_started = Arc::new(AtomicBool::new(false));
    let js_start = just_started.clone();
    let js_update = just_started.clone();

    let plugin = FnBoundaryPlugin::new(
        |line| line.trim() == "@@@",
        move |line| {
            if js_update.swap(false, Ordering::SeqCst) {
                return BoundaryUpdate::Continue;
            }
            if line.trim() == "@@@" {
                BoundaryUpdate::Close
            } else {
                BoundaryUpdate::Continue
            }
        },
    )
    .with_start(move |_| {
        js_start.store(true, Ordering::SeqCst);
    });

    let markdown = "Intro\n\n@@@\nA\n\nB\n@@@\n\nAfter\n";

    let blocks_whole = support::collect_final_raw_with_stream(
        support::chunk_whole(markdown),
        MdStream::new(Options::default()).with_boundary_plugin(plugin),
    );

    let just_started = Arc::new(AtomicBool::new(false));
    let js_start = just_started.clone();
    let js_update = just_started.clone();
    let plugin = FnBoundaryPlugin::new(
        |line| line.trim() == "@@@",
        move |line| {
            if js_update.swap(false, Ordering::SeqCst) {
                return BoundaryUpdate::Continue;
            }
            if line.trim() == "@@@" {
                BoundaryUpdate::Close
            } else {
                BoundaryUpdate::Continue
            }
        },
    )
    .with_start(move |_| {
        js_start.store(true, Ordering::SeqCst);
    });
    let blocks_lines = support::collect_final_raw_with_stream(
        support::chunk_lines(markdown),
        MdStream::new(Options::default()).with_boundary_plugin(plugin),
    );

    let just_started = Arc::new(AtomicBool::new(false));
    let js_start = just_started.clone();
    let js_update = just_started.clone();
    let plugin = FnBoundaryPlugin::new(
        |line| line.trim() == "@@@",
        move |line| {
            if js_update.swap(false, Ordering::SeqCst) {
                return BoundaryUpdate::Continue;
            }
            if line.trim() == "@@@" {
                BoundaryUpdate::Close
            } else {
                BoundaryUpdate::Continue
            }
        },
    )
    .with_start(move |_| {
        js_start.store(true, Ordering::SeqCst);
    });
    let blocks_chars = support::collect_final_raw_with_stream(
        support::chunk_chars(markdown),
        MdStream::new(Options::default()).with_boundary_plugin(plugin),
    );

    let just_started = Arc::new(AtomicBool::new(false));
    let js_start = just_started.clone();
    let js_update = just_started.clone();
    let plugin = FnBoundaryPlugin::new(
        |line| line.trim() == "@@@",
        move |line| {
            if js_update.swap(false, Ordering::SeqCst) {
                return BoundaryUpdate::Continue;
            }
            if line.trim() == "@@@" {
                BoundaryUpdate::Close
            } else {
                BoundaryUpdate::Continue
            }
        },
    )
    .with_start(move |_| {
        js_start.store(true, Ordering::SeqCst);
    });
    let blocks_rand = support::collect_final_raw_with_stream(
        support::chunk_pseudo_random(markdown, "fn_boundary_plugin_chunking_invariance", 0, 40),
        MdStream::new(Options::default()).with_boundary_plugin(plugin),
    );

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