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).

This is a thin wrapper around Rga<char> that provides text-specific convenience methods like insert_str, remove_range, and Display.

§Example

use crdt_kit::prelude::*;

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

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

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: NodeId) -> Self

Create a new empty text CRDT for the given node.

Source

pub fn fork(&self, new_actor: NodeId) -> Self

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

Source

pub fn insert(&mut self, index: usize, ch: char) -> Result<(), TextError>

Insert a character at the given visible index.

Source

pub fn insert_str(&mut self, index: usize, s: &str) -> Result<(), TextError>

Insert a string at the given visible index.

Source

pub fn remove(&mut self, index: usize) -> Result<(), TextError>

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

Source

pub fn remove_range( &mut self, start: usize, count: usize, ) -> Result<(), TextError>

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

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) -> NodeId

Get this replica’s node 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 DeltaCrdt for TextCrdt

Source§

type Delta = RgaDelta<char>

The type of delta produced by this CRDT.
Source§

fn delta(&self, other: &Self) -> TextDelta

Generate a delta containing changes in self that other does not have. Read more
Source§

fn apply_delta(&mut self, delta: &TextDelta)

Apply a delta to this replica’s state. 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 Versioned for TextCrdt

Source§

const CURRENT_VERSION: u8 = 1

Current schema version for this CRDT type’s serialization format.
Source§

const CRDT_TYPE: CrdtType = CrdtType::TextCrdt

The CRDT type identifier for the envelope.
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.