braid-core 0.1.4

Unified Braid Protocol implementation in Rust, including Braid-HTTP, Antimatter CRDT, and BraidFS.
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

//! Merge algorithms and CRDT implementations for conflict resolution.
//!
//! This module provides merge strategies for resolving concurrent edits to the same resource
//! when multiple clients make simultaneous mutations. The module includes built-in support
//! for CRDT-based merge algorithms.
//!
//! # Merge-Types in Braid-HTTP
//!
//! Per Section 2.2 of [draft-toomim-httpbis-braid-http-04], resources can declare a merge type
//! to specify how concurrent edits should be reconciled:
//!
//! | Merge Type | Description |
//! |------------|-------------|
//! //! | `"diamond"` | Diamond-types CRDT for text documents |
//! | `"antimatter"` | Antimatter CRDT with pruning |
//! | Custom | Application-defined merge algorithms |
//!
//! # Key Types
//!
//! | Type | Description |
//! |------|-------------|
//! | [`MergeType`] | Trait for pluggable merge algorithms |
//! //! | [`AntimatterMergeType`] | Antimatter CRDT with pruning |
//! | [`DiamondCRDT`] | High-performance text CRDT |
//! | [`MergeTypeRegistry`] | Factory for creating merge type instances |
//!
//! [draft-toomim-httpbis-braid-http-04]: https://datatracker.ietf.org/doc/html/draft-toomim-httpbis-braid-http

pub mod antimatter_merge;
pub mod merge_type;

#[cfg(not(target_arch = "wasm32"))]
pub mod diamond;

// Re-exports
pub use antimatter_merge::AntimatterMergeType;
pub use merge_type::{MergePatch, MergeResult, MergeType, MergeTypeRegistry};

#[cfg(not(target_arch = "wasm32"))]
pub use diamond::{DiamondCRDT, DiamondMergeType};