surreal-sync-runtime 0.6.0

Shared runtime: apply pipeline, init, SurrealDB config, and transform loading for surreal-sync
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

//! NDJSON wire headers for external transform requests/responses.

use serde::{Deserialize, Serialize};

/// Item payload kind for an External NDJSON exchange.
///
/// Workers that only handle row CDC may ignore `kind` (default / omitted =
/// [`WireItemKind::Change`]). Relation-aware workers must honor `kind` so
/// relation batches are not silently treated as row changes.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
#[serde(rename_all = "snake_case")]
pub enum WireItemKind {
    /// Incremental row [`surreal_sync_core::Change`] items.
    #[default]
    Change,
    /// Full-sync / snapshot [`surreal_sync_core::Row`] items.
    Row,
    /// Incremental relation [`surreal_sync_core::RelationChange`] items.
    RelationChange,
    /// Full-sync [`surreal_sync_core::Relation`] items.
    Relation,
}

/// Request header line: `{"batch_id","count"}` plus optional `kind`.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct RequestHeader {
    pub batch_id: u64,
    pub count: usize,
    /// Payload kind. Omitted / default = [`WireItemKind::Change`] for back-compat.
    #[serde(default, skip_serializing_if = "is_default_kind")]
    pub kind: WireItemKind,
}

fn is_default_kind(kind: &WireItemKind) -> bool {
    *kind == WireItemKind::Change
}

/// Response header line: must echo `batch_id`; either `count` + items or `error`.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct ResponseHeader {
    pub batch_id: u64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub count: Option<usize>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}