Skip to main content

TextCrdt

Struct TextCrdt 

Source
pub struct TextCrdt { /* private fields */ }
Expand description

A collaborative text CRDT based on RGA (Replicated Growable Array) principles.

Each character is assigned a unique identifier (actor, counter) and is stored in an internal sequence. Deletions use tombstones: characters are marked as deleted but remain in the internal list so that concurrent operations from different replicas can be merged deterministically.

Ordering of concurrent inserts at the same position is resolved by comparing (counter, actor) tuples — higher counters come first, and ties are broken lexicographically by actor ID.

§Example

use crdt_kit::prelude::*;

let mut t1 = TextCrdt::new("alice");
t1.insert_str(0, "hello");

let mut t2 = TextCrdt::new("bob");
t2.insert_str(0, "world");

t1.merge(&t2);
t2.merge(&t1);

// Both replicas converge to the same text.
assert_eq!(t1.to_string(), t2.to_string());

Implementations§

Source§

impl TextCrdt

Source

pub fn new(actor: impl Into<String>) -> Self

Create a new empty text CRDT for the given actor.

Source

pub fn fork(&self, new_actor: impl Into<String>) -> Self

Create a fork of this replica with a different actor ID.

The returned replica contains an identical copy of the current content and version state, but subsequent inserts will use the new actor, preventing ID collisions between the two replicas.

Source

pub fn insert(&mut self, index: usize, ch: char)

Insert a character at the given visible index.

§Panics

Panics if index is greater than self.len().

Source

pub fn insert_str(&mut self, index: usize, s: &str)

Insert a string at the given visible index.

Characters are inserted left-to-right so that the resulting visible text contains the string starting at index.

§Panics

Panics if index is greater than self.len().

Source

pub fn remove(&mut self, index: usize)

Remove (tombstone) the character at the given visible index.

§Panics

Panics if index is greater than or equal to self.len().

Source

pub fn remove_range(&mut self, start: usize, len: usize)

Remove a range of characters starting at start with the given len.

§Panics

Panics if start + len is greater than self.len().

Source

pub fn len(&self) -> usize

Return the number of visible (non-deleted) characters.

Source

pub fn is_empty(&self) -> bool

Check whether the visible text is empty.

Source

pub fn actor(&self) -> &str

Get this replica’s actor ID.

Trait Implementations§

Source§

impl Clone for TextCrdt

Source§

fn clone(&self) -> TextCrdt

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Crdt for TextCrdt

Source§

fn merge(&mut self, other: &Self)

Merge another replica’s state into this one. Read more
Source§

impl Debug for TextCrdt

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for TextCrdt

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for TextCrdt

Source§

fn eq(&self, other: &TextCrdt) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for TextCrdt

Source§

impl StructuralPartialEq for TextCrdt

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.