10 unstable releases (3 breaking)

0.4.5 Apr 3, 2024
0.4.4 Feb 1, 2024
0.4.3 Jan 31, 2024
0.3.0 Jan 9, 2024
0.1.1 Dec 12, 2023

#3 in #collaboration

Download history 141/week @ 2024-01-18 78/week @ 2024-01-25 78/week @ 2024-02-01 7/week @ 2024-02-08 29/week @ 2024-02-22 4/week @ 2024-02-29 26/week @ 2024-03-07 177/week @ 2024-03-14 141/week @ 2024-03-21 95/week @ 2024-03-28 59/week @ 2024-04-04 4/week @ 2024-04-11 7/week @ 2024-04-18 59/week @ 2024-04-25 26/week @ 2024-05-02

97 downloads per month
Used in 3 crates (2 directly)

MIT license

315KB
7K SLoC

🥤 cola

Latest version Docs badge CI

cola is a Conflict-free Replicated Data Type specialized for real-time collaborative editing of plain text documents.

It allows multiple peers on a distributed network to concurrently edit the same text document, making sure that they all converge to the same final state without relying on a central server to coordinate the edits.

Check out the docs to learn about cola's API, or this blog post for a deeper dive into its design and implementation.

Example usage

use std::ops::Range;

use cola::{Deletion, Replica, ReplicaId};

struct Document {
    buffer: String,
    crdt: Replica,
}

struct Insertion {
    text: String,
    crdt: cola::Insertion,
}

impl Document {
    fn new<S: Into<String>>(text: S, replica_id: ReplicaId) -> Self {
        let buffer = text.into();
        let crdt = Replica::new(replica_id, buffer.len());
        Document { buffer, crdt }
    }

    fn fork(&self, new_replica_id: ReplicaId) -> Self {
        let crdt = self.crdt.fork(new_replica_id);
        Document { buffer: self.buffer.clone(), crdt }
    }

    fn insert<S: Into<String>>(
        &mut self,
        insert_at: usize,
        text: S,
    ) -> Insertion {
        let text = text.into();
        self.buffer.insert_str(insert_at, &text);
        let insertion = self.crdt.inserted(insert_at, text.len());
        Insertion { text, crdt: insertion }
    }

    fn delete(&mut self, range: Range<usize>) -> Deletion {
        self.buffer.replace_range(range.clone(), "");
        self.crdt.deleted(range)
    }

    fn integrate_insertion(&mut self, insertion: Insertion) {
        if let Some(offset) = self.crdt.integrate_insertion(&insertion.crdt) {
            self.buffer.insert_str(offset, &insertion.text);
        }
    }

    fn integrate_deletion(&mut self, deletion: Deletion) {
        let ranges = self.crdt.integrate_deletion(&deletion);
        for range in ranges.into_iter().rev() {
            self.buffer.replace_range(range, "");
        }
    }
}

fn main() {
    let mut peer_1 = Document::new("Hello, world", 1);
    let mut peer_2 = peer_1.fork(2);

    let delete_comma = peer_1.delete(5..6);
    let insert_exclamation = peer_2.insert(12, "!");

    peer_1.integrate_insertion(insert_exclamation);
    peer_2.integrate_deletion(delete_comma);

    assert_eq!(peer_1.buffer, "Hello world!");
    assert_eq!(peer_2.buffer, "Hello world!");
}

Dependencies

~0–250KB