Skip to main content

Rga

Struct Rga 

Source
pub struct Rga<T: Clone + Ord> { /* private fields */ }
Expand description

A Replicated Growable Array (RGA) — an ordered sequence CRDT.

RGA supports insert and delete at arbitrary positions while guaranteeing convergence across replicas. Each element is assigned a unique identifier (actor, counter) which determines causal ordering.

§Example

use crdt_kit::prelude::*;

let mut list1 = Rga::new(1);
list1.insert_at(0, 'H').unwrap();
list1.insert_at(1, 'i').unwrap();

let mut list2 = Rga::new(2);
list2.insert_at(0, '!').unwrap();

list1.merge(&list2);
list2.merge(&list1);

// Both replicas converge to the same sequence
let v1: Vec<&char> = list1.iter().collect();
let v2: Vec<&char> = list2.iter().collect();
assert_eq!(v1, v2);
assert_eq!(list1.len(), 3);

Implementations§

Source§

impl<T: Clone + Ord> Rga<T>

Source

pub fn new(actor: NodeId) -> Self

Create a new empty RGA 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_at(&mut self, index: usize, value: T) -> Result<(), RgaError>

Insert a value at the given index in the visible sequence.

Source

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

Remove the element at the given index from the visible sequence.

Source

pub fn get(&self, index: usize) -> Option<&T>

Get a reference to the element at the given index in the visible sequence.

Source

pub fn len(&self) -> usize

Get the number of visible (non-tombstoned) elements.

Source

pub fn is_empty(&self) -> bool

Check if the visible sequence is empty.

Source

pub fn iter(&self) -> impl Iterator<Item = &T> + '_

Iterate over the visible elements in order.

Source

pub fn actor(&self) -> NodeId

Get this replica’s node ID.

Source

pub fn to_vec(&self) -> Vec<T>

Collect visible elements into a Vec.

Trait Implementations§

Source§

impl<T: Clone + Clone + Ord> Clone for Rga<T>

Source§

fn clone(&self) -> Rga<T>

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<T: Clone + Ord> Crdt for Rga<T>

Source§

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

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

impl<T: Debug + Clone + Ord> Debug for Rga<T>

Source§

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

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

impl<T: Clone + Ord> DeltaCrdt for Rga<T>

Source§

type Delta = RgaDelta<T>

The type of delta produced by this CRDT.
Source§

fn delta(&self, other: &Self) -> RgaDelta<T>

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

fn apply_delta(&mut self, delta: &RgaDelta<T>)

Apply a delta to this replica’s state. Read more
Source§

impl<T: PartialEq + Clone + Ord> PartialEq for Rga<T>

Source§

fn eq(&self, other: &Rga<T>) -> 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<T: Clone + Ord> Versioned for Rga<T>

Source§

const CURRENT_VERSION: u8 = 1

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

const CRDT_TYPE: CrdtType = CrdtType::Rga

The CRDT type identifier for the envelope.
Source§

impl<T: Eq + Clone + Ord> Eq for Rga<T>

Source§

impl<T: Clone + Ord> StructuralPartialEq for Rga<T>

Auto Trait Implementations§

§

impl<T> Freeze for Rga<T>

§

impl<T> RefUnwindSafe for Rga<T>
where T: RefUnwindSafe,

§

impl<T> Send for Rga<T>
where T: Send,

§

impl<T> Sync for Rga<T>
where T: Sync,

§

impl<T> Unpin for Rga<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Rga<T>

§

impl<T> UnwindSafe for Rga<T>
where T: UnwindSafe,

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