Struct crdts::ctx::ReadCtx

pub struct ReadCtx<V, A: Ord> {
    pub add_clock: VClock<A>,
    pub rm_clock: VClock<A>,
    pub val: V,
}

ReadCtx’s are used to extract data from CRDT’s while maintaining some causal history. You should store ReadCtx’s close to where mutation is exposed to the user.

e.g. Ship ReadCtx to the clients, then derive an Add/RmCtx and ship that back to where the CRDT is stored to perform the mutation operation.

Fields

add_clock: VClock<A>

clock used to derive an AddCtx

rm_clock: VClock<A>

clock used to derive an RmCtx

val: V

the data read from the CRDT

Implementations

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

pub fn derive_add_ctx(self, actor: A) -> AddCtx<A>

Derives an AddCtx for a given actor from a ReadCtx

pub fn derive_rm_ctx(self) -> RmCtx<A>

Derives a RmCtx from a ReadCtx

pub fn split(self) -> (V, ReadCtx<(), A>)

Splits this ReadCtx into its data and an empty ReadCtx

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'de, V, A> Deserialize<'de> for ReadCtx<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: PartialEq, A: PartialEq + Ord> PartialEq<ReadCtx<V, A>> for ReadCtx<V, A>

fn eq(&self, other: &ReadCtx<V, A>) -> 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> Serialize for ReadCtx<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: Eq + Ord> Eq for ReadCtx<V, A>

impl<V, A: Ord> StructuralEq for ReadCtx<V, A>

impl<V, A: Ord> StructuralPartialEq for ReadCtx<V, A>