nodedb-types 0.4.0

Portable type definitions shared between NodeDB Origin and NodeDB-Lite
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

// SPDX-License-Identifier: Apache-2.0

//! Spatial insert/delete sync messages (client → server / server → client).
//!
//! `SpatialInsertMsg` carries one geometry entry from a Lite client to
//! Origin for R-tree indexing. `SpatialDeleteMsg` removes a document's
//! geometry from Origin's R-tree.
//!
//! Wire opcodes:
//! - `0xAA` — `SpatialInsert`    (Lite → Origin)
//! - `0xAB` — `SpatialInsertAck` (Origin → Lite)
//! - `0xAC` — `SpatialDelete`    (Lite → Origin)
//! - `0xAD` — `SpatialDeleteAck` (Origin → Lite)

use serde::{Deserialize, Serialize};

use crate::sync::wire::ack_status::AckStatus;

/// Spatial insert request (Lite → Origin, 0xAA).
///
/// Requests that Origin index the geometry for `(collection, field, doc_id)` in
/// its per-field R-tree. Origin assigns a surrogate for `doc_id`, computes the
/// bounding box from the geometry, and inserts the entry into
/// `CoreLoop::spatial_indexes`.
///
/// `geometry_bytes` is a MessagePack-serialised `nodedb_types::geometry::Geometry`
/// value produced via `zerompk::to_msgpack_vec(&geometry)`.
#[derive(
    Debug, Clone, Serialize, Deserialize, zerompk::ToMessagePack, zerompk::FromMessagePack,
)]
pub struct SpatialInsertMsg {
    /// Lite instance ID (for routing and dedup).
    pub lite_id: String,
    /// Target collection name.
    pub collection: String,
    /// Geometry field name within the collection.
    pub field: String,
    /// External document identifier.
    pub doc_id: String,
    /// MessagePack-serialised `Geometry` value.
    pub geometry_bytes: Vec<u8>,
    /// Monotonic batch ID (Lite-assigned, per-operation). Used for ACK correlation.
    pub batch_id: u64,
    /// Stable identity of the originating producer. 0 for legacy clients.
    #[serde(default)]
    pub producer_id: u64,
    /// Monotonic epoch counter incremented on every producer restart.
    #[serde(default)]
    pub epoch: u64,
    /// Per-stream monotonic sequence number within the epoch.
    #[serde(default)]
    pub seq: u64,
}

/// Spatial insert acknowledgment (Origin → Lite, 0xAB).
#[derive(
    Debug, Clone, Serialize, Deserialize, zerompk::ToMessagePack, zerompk::FromMessagePack,
)]
pub struct SpatialInsertAckMsg {
    /// Collection acknowledged.
    pub collection: String,
    /// Field acknowledged.
    pub field: String,
    /// Document ID from the originating `SpatialInsertMsg`.
    pub doc_id: String,
    /// Batch ID from the originating `SpatialInsertMsg`.
    pub batch_id: u64,
    /// `true` if the geometry was successfully indexed on Origin.
    pub accepted: bool,
    /// Rejection detail when `accepted == false`.
    #[serde(default)]
    pub reject_reason: Option<String>,
    /// Highest sequence number from this producer that has been durably applied.
    #[serde(default)]
    pub applied_seq: u64,
    /// Idempotency outcome of the acknowledged message.
    #[serde(default)]
    pub status: AckStatus,
}

/// Spatial delete request (Lite → Origin, 0xAC).
///
/// Removes the document identified by `doc_id` from Origin's R-tree index
/// for the given `(collection, field)`.
#[derive(
    Debug, Clone, Serialize, Deserialize, zerompk::ToMessagePack, zerompk::FromMessagePack,
)]
pub struct SpatialDeleteMsg {
    /// Lite instance ID.
    pub lite_id: String,
    /// Target collection name.
    pub collection: String,
    /// Geometry field name within the collection.
    pub field: String,
    /// External document identifier to remove.
    pub doc_id: String,
    /// Monotonic batch ID for ACK correlation.
    pub batch_id: u64,
    /// Stable identity of the originating producer. 0 for legacy clients.
    #[serde(default)]
    pub producer_id: u64,
    /// Monotonic epoch counter incremented on every producer restart.
    #[serde(default)]
    pub epoch: u64,
    /// Per-stream monotonic sequence number within the epoch.
    #[serde(default)]
    pub seq: u64,
}

/// Spatial delete acknowledgment (Origin → Lite, 0xAD).
#[derive(
    Debug, Clone, Serialize, Deserialize, zerompk::ToMessagePack, zerompk::FromMessagePack,
)]
pub struct SpatialDeleteAckMsg {
    /// Collection acknowledged.
    pub collection: String,
    /// Field acknowledged.
    pub field: String,
    /// Document ID from the originating `SpatialDeleteMsg`.
    pub doc_id: String,
    /// Batch ID from the originating `SpatialDeleteMsg`.
    pub batch_id: u64,
    /// `true` if the document was successfully removed from Origin's R-tree.
    pub accepted: bool,
    /// Rejection detail when `accepted == false`.
    #[serde(default)]
    pub reject_reason: Option<String>,
    /// Highest sequence number from this producer that has been durably applied.
    #[serde(default)]
    pub applied_seq: u64,
    /// Idempotency outcome of the acknowledged message.
    #[serde(default)]
    pub status: AckStatus,
}