Skip to main content

che_sync_protocol/
object_log.rs

1//! Explicit protocol 3: principal-bound delivery of current object projections.
2use crate::model_log::{ModelState, ModelWriteResult};
3use serde::{Deserialize, Serialize};
4use uuid::Uuid;
5
6pub const OBJECT_LOG_PROTOCOL: u32 = 3;
7
8#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
9pub struct ObjectRights {
10    pub read: bool,
11    pub change: bool,
12    pub delete: bool,
13}
14
15#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
16pub struct ObjectCursor {
17    pub model: String,
18    pub history: Uuid,
19    /// Opaque, persistent identity bound to the authenticated account and model.
20    pub feed: Uuid,
21    #[serde(with = "crate::decimal_i64")]
22    pub sequence: i64,
23}
24
25#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
26#[serde(tag = "kind", rename_all = "snake_case")]
27pub enum ObjectChange {
28    State {
29        state: ModelState,
30        rights: ObjectRights,
31    },
32    Revoked {
33        record_id: Uuid,
34    },
35    Deleted {
36        record_id: Uuid,
37        #[serde(with = "crate::decimal_i64")]
38        revision: i64,
39    },
40}
41#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
42pub struct ObjectEvent {
43    #[serde(with = "crate::decimal_i64")]
44    pub sequence: i64,
45    pub change: ObjectChange,
46}
47#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
48pub struct ObjectChanges {
49    pub protocol_version: u32,
50    pub cursor: ObjectCursor,
51    /// Exact request boundary; clients reject gaps, overlaps and stale pages.
52    #[serde(with = "crate::decimal_i64")]
53    pub after: i64,
54    pub events: Vec<ObjectEvent>,
55    pub can_create: bool,
56    pub has_more: bool,
57}
58#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
59#[serde(rename_all = "snake_case")]
60pub enum WriteOutcome {
61    Accepted,
62    Conflict,
63    Rejected,
64}
65#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
66#[serde(tag = "kind", content = "data", rename_all = "snake_case")]
67pub enum ObjectWriteResult {
68    Canonical(ModelWriteResult),
69    /// The immutable receipt is unchanged. Only its outcome is disclosed.
70    Acknowledged {
71        operation_id: Uuid,
72        outcome: WriteOutcome,
73    },
74}