Struct crdts::lseq::LSeq

pub struct LSeq<T, A: Actor> { /* fields omitted */ }

As described in the module documentation:

An LSEQ tree is a CRDT for storing sequences of data (Strings, ordered lists). It provides an efficient view of the stored sequence, with fast index, insertion and deletion operations.

Implementations

impl<T: Clone, A: Actor> LSeq<T, A>

pub fn new(id: A) -> Self

Create an empty LSEQ

pub fn new_with_args(id: A, base: u8, boundary: u64) -> Self

Create an empty LSEQ with custom base size

pub fn insert_index(&mut self, ix: usize, val: T) -> Op<T, A>

Perform a local insertion of an element at a given position. If ix is greater than the length of the LSeq then it is appended to the end.

Panics

• If the allocation of a new index was not between ix and ix - 1.

pub fn append(&mut self, c: T) -> Op<T, A>

Perform a local insertion of an element at the end of the sequence.

pub fn delete_index(&mut self, ix: usize) -> Option<Op<T, A>>

Perform a local deletion at ix.

If ix is out of bounds, i.e. ix > self.len(), then the Op is not performed and None is returned.

pub fn delete_index_or_last(&mut self, ix: usize) -> Op<T, A>

Perform a local deletion at ix. If ix is out of bounds then the last element will be deleted, i.e. self.len() - 1.

pub fn len(&self) -> usize

Get the length of the LSEQ.

pub fn is_empty(&self) -> bool

Check if the LSEQ is empty.

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

Get the elements represented by the LSEQ.

pub fn iter_entries(&self) -> impl Iterator<Item = &Entry<T, A>> + '_

Get the elements' Entry from the LSEQ.

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

Get an element at an index from the sequence represented by the LSEQ.

pub fn find_entry(&self, ident: &Identifier<A>) -> Option<&Entry<T, A>>

Finds an entry searching by its Identifier.

pub fn last(&self) -> Option<&T>

Get last element of the sequence represented by the LSEQ.

pub fn last_entry(&self) -> Option<&Entry<T, A>>

Get the last Entry of the sequence represented by the LSEQ.

pub fn actor(&self) -> A

Actor who is initiating operations on this LSeq

Trait Implementations

impl<T: Clone, A: Clone + Actor> Clone for LSeq<T, A>

fn clone(&self) -> LSeq<T, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Clone, A: Actor> CmRDT for LSeq<T, A>

type Op = Op<T, A>

Op defines a mutation to the CRDT. As long as Op's from one actor are replayed in exactly the same order they were generated by that actor, the CRDT will converge. In other words, we must have a total ordering on each actors operations, while requiring only a partial order over all ops. E.g.

fn apply(&mut self, op: Self::Op)

Apply an operation to an LSeq instance.

If the operation is an insert and the identifier is already present in the LSEQ instance the result is a no-op

If the operation is a delete and the identifier is not present in the LSEQ instance the result is a no-op

impl<'de, T, A: Actor> Deserialize<'de> for LSeq<T, A> where
    T: Deserialize<'de>,
    A: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: Eq, A: Eq + Actor> Eq for LSeq<T, A>

impl<T: Hash, A: Hash + Actor> Hash for LSeq<T, A>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T: PartialEq, A: PartialEq + Actor> PartialEq<LSeq<T, A>> for LSeq<T, A>

fn eq(&self, other: &LSeq<T, A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LSeq<T, A>) -> bool

This method tests for !=.

impl<T: PartialOrd, A: PartialOrd + Actor> PartialOrd<LSeq<T, A>> for LSeq<T, A>

fn partial_cmp(&self, other: &LSeq<T, A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &LSeq<T, A>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &LSeq<T, A>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &LSeq<T, A>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &LSeq<T, A>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, A: Actor> Serialize for LSeq<T, A> where
    T: Serialize,
    A: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T, A: Actor> StructuralEq for LSeq<T, A>

impl<T, A: Actor> StructuralPartialEq for LSeq<T, A>