tinymist-preview 0.14.20-rc1

A previewer for the Typst typesetting system.
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

//! Preview data-plane protocol helpers.

/// Prefix for incremental vector document updates.
pub const DIFF_V1_PREFIX: &[u8] = b"diff-v1,";

/// Prefix for a full current vector document update.
pub const NEW_PREFIX: &[u8] = b"new,";

/// A preview data-plane frame with its prefix stripped.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PreviewDataFrame<'a> {
    /// An incremental update.
    DiffV1(&'a [u8]),
    /// A full current update. Clients must reset their render state before
    /// merging the payload.
    FullCurrent(&'a [u8]),
}

/// Splits a preview data-plane binary frame into its event kind and payload.
pub fn split_preview_data_frame(bytes: &[u8]) -> Option<PreviewDataFrame<'_>> {
    if let Some(payload) = bytes.strip_prefix(DIFF_V1_PREFIX) {
        Some(PreviewDataFrame::DiffV1(payload))
    } else {
        bytes
            .strip_prefix(NEW_PREFIX)
            .map(PreviewDataFrame::FullCurrent)
    }
}

/// Converts a complete initial incremental update into a full-current update.
///
/// A fresh incremental renderer emits a self-contained `diff-v1,` payload. The
/// full-current data-plane event uses the same payload format with a `new,`
/// prefix so clients reset their local state before merging it.
pub fn full_current_frame_from_delta(delta_frame: &[u8]) -> Option<Vec<u8>> {
    let payload = delta_frame.strip_prefix(DIFF_V1_PREFIX)?;
    Some([NEW_PREFIX, payload].concat())
}