lix 0.15.1

Embeddable version control for apps and AI agents.
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

//! Platform-neutral transport contract consumed by the shared sync engine.
//!
//! The Lix connection URL already selects one hosted Lix. Accordingly the
//! live protocol has one cursor and no branch, schema, projection, or session
//! topology side channels. HTTP, task, timer, and cancellation mechanics live
//! under [`super::platform`].

use super::{
    SyncBlobManifest, SyncBlobRegistration, SyncHistoryResponse, SyncPushRequest, SyncPushResponse,
    SyncRepositoryPullResponse, SyncSnapshotRowPage, SyncTransportBounds, SyncTransportFuture,
};

/// Operations required from a remote repository authority.
///
/// Commits and ref updates use one ordered repository cursor. Binary payloads
/// use their independent BLAKE3/FastCDC CAS and are transferred only when a
/// commit references content absent on the receiving side.
#[allow(
    dead_code,
    reason = "the connected cache is read-only, while protocol transports retain authority write operations"
)]
pub trait SyncTransport: SyncTransportBounds {
    /// Account authenticated by the authority handshake for this session.
    fn active_account_id(&self) -> &str;

    /// Atomically publishes immutable commits and compare-and-swap ref moves.
    fn push<'a>(
        &'a self,
        request: &'a SyncPushRequest,
    ) -> SyncTransportFuture<'a, SyncPushResponse>;

    /// Loads hot state when `after` is `None`, otherwise long-polls the single
    /// ordered repository event stream after that cursor.
    fn pull(
        &self,
        after: Option<u64>,
        limit: usize,
    ) -> SyncTransportFuture<'_, SyncRepositoryPullResponse>;

    /// Performs the same pull without waiting when `after` is already the
    /// authority head. This is private transport behavior; the wire body and
    /// public protocol schema remain unchanged.
    fn pull_now(
        &self,
        after: Option<u64>,
        limit: usize,
    ) -> SyncTransportFuture<'_, SyncRepositoryPullResponse> {
        self.pull(after, limit)
    }

    /// Loads one bounded hot-row page at an immutable branch head.
    fn snapshot_rows<'a>(
        &'a self,
        branch_id: &'a str,
        head_commit_id: &'a str,
        continuation: Option<&'a str>,
        limit: usize,
    ) -> SyncTransportFuture<'a, SyncSnapshotRowPage>;

    /// Loads one bounded first-parent history page without changing live sync
    /// state. A later missing ancestor becomes the head of the next demand.
    fn history<'a>(
        &'a self,
        head: &'a str,
        limit: usize,
    ) -> SyncTransportFuture<'a, SyncHistoryResponse>;

    /// Loads one bounded batch of canonical flat blob manifests.
    fn get_blobs<'a>(
        &'a self,
        blob_ids: &'a [String],
    ) -> SyncTransportFuture<'a, Vec<SyncBlobManifest>>;

    /// Negotiates missing chunks and atomically registers a verified manifest.
    fn register_blob<'a>(
        &'a self,
        manifest: &'a SyncBlobManifest,
    ) -> SyncTransportFuture<'a, SyncBlobRegistration>;

    /// Loads one raw BLAKE3-addressed chunk, if present.
    fn get_chunk<'a>(&'a self, chunk_id: &'a str) -> SyncTransportFuture<'a, Option<Vec<u8>>>;

    /// Stores one raw chunk after the authority verifies its BLAKE3 identity.
    fn put_chunk<'a>(&'a self, chunk_id: &'a str, bytes: &'a [u8]) -> SyncTransportFuture<'a, ()>;
}