Struct crdts::mvreg::MVReg

pub struct MVReg<V, A: Ord> { /* private fields */ }

MVReg (Multi-Value Register) On concurrent writes, we will keep all values for which we can’t establish a causal history.

use crdts::{CmRDT, MVReg, Dot, VClock};
let mut r1 = MVReg::new();
let mut r2 = r1.clone();
let r1_read_ctx = r1.read();
let r2_read_ctx = r2.read();

r1.apply(r1.write("bob", r1_read_ctx.derive_add_ctx(123)));

let op = r2.write("alice", r2_read_ctx.derive_add_ctx(111));
r2.apply(op.clone());

r1.apply(op); // we replicate op to r1

// Since "bob" and "alice" were added concurrently, we see both on read
assert_eq!(r1.read().val, vec!["bob", "alice"]);

Implementations

impl<V, A: Ord + Clone + Debug> MVReg<V, A>

pub fn new() -> Self

Construct a new empty MVReg

pub fn write(&self, val: V, ctx: AddCtx<A>) -> Op<V, A>

Set the value of the register

pub fn read(&self) -> ReadCtx<Vec<V>, A>where V: Clone,

Consumes the register and returns the values

pub fn read_ctx(&self) -> ReadCtx<(), A>

Retrieve the current read context

Trait Implementations

impl<V: Clone, A: Clone + Ord> Clone for MVReg<V, A>

fn clone(&self) -> MVReg<V, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V, A: Ord> CmRDT for MVReg<V, A>

type Op = Op<V, 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.

type Validation = Infallible

The validation error returned by validate_op.

fn validate_op(&self, _op: &Self::Op) -> Result<(), Self::Validation>

Some CRDT’s have stricter requirements on how they must be used. To avoid violating these requirements, CRDT’s provide an interface to optionally validate op’s before they are applied.

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

Apply an Op to the CRDT

impl<V, A: Ord> CvRDT for MVReg<V, A>

type Validation = Infallible

The validation error returned by validate_merge.

fn validate_merge(&self, _other: &Self) -> Result<(), Self::Validation>

Some CRDT’s have stricter requirements on how they must be used. To avoid violating these requirements, CRDT’s provide an interface to optionally validate merge compatibility before attempting to merge.

fn merge(&mut self, other: Self)

Merge the given CRDT into the current CRDT.

impl<V: Debug, A: Debug + Ord> Debug for MVReg<V, A>

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

Formats the value using the given formatter.

impl<V, A: Ord> Default for MVReg<V, A>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, V, A> Deserialize<'de> for MVReg<V, A>where V: Deserialize<'de>, A: Deserialize<'de> + Ord,

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

Deserialize this value from the given Serde deserializer.

impl<V: Display, A: Ord + Display> Display for MVReg<V, A>

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

Formats the value using the given formatter.

impl<V: PartialEq, A: Ord> PartialEq<MVReg<V, A>> for MVReg<V, A>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<V, A: Ord> ResetRemove<A> for MVReg<V, A>

fn reset_remove(&mut self, clock: &VClock<A>)

Remove data that is strictly smaller than this clock

impl<V, A> Serialize for MVReg<V, A>where V: Serialize, A: Serialize + Ord,

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

Serialize this value into the given Serde serializer.

impl<V: Eq, A: Ord> Eq for MVReg<V, A>