Struct crdts::gcounter::GCounter

pub struct GCounter<A: Ord> { /* fields omitted */ }

GCounter is a grow-only witnessed counter.

Examples

use crdts::{GCounter, CmRDT};

let mut a = GCounter::new();
let mut b = GCounter::new();

a.apply(a.inc("A"));
b.apply(b.inc("B"));

assert_eq!(a.read(), b.read());

a.apply(a.inc("A"));
assert!(a.read() > b.read());

Implementations

impl<A: Ord + Clone> GCounter<A>

pub fn new() -> Self

Produce a new GCounter.

pub fn inc(&self, actor: A) -> Dot<A>

Generate Op to increment the counter.

pub fn inc_many(&self, actor: A, steps: u64) -> Dot<A>

Generate Op to increment the counter by a number of steps.

pub fn read(&self) -> BigUint

Return the current sum of this counter.

Trait Implementations

impl<A: Clone + Ord> Clone for GCounter<A>

fn clone(&self) -> GCounter<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Ord + Clone + Debug> CmRDT for GCounter<A>

type Op = Dot<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<A: Ord + Clone + Debug> CvRDT for GCounter<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<A: Debug + Ord> Debug for GCounter<A>

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

Formats the value using the given formatter.

impl<A: Ord> Default for GCounter<A>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, A: Ord> Deserialize<'de> for GCounter<A> where
    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<A: Eq + Ord> Eq for GCounter<A>

impl<A: Hash + Ord> Hash for GCounter<A>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<A: PartialEq + Ord> PartialEq<GCounter<A>> for GCounter<A>

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

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

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

This method tests for !=.

impl<A: Ord> ResetRemove<A> for GCounter<A>

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

Remove data that is strictly smaller than this clock

impl<A: Ord> Serialize for GCounter<A> where
    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<A: Ord> StructuralEq for GCounter<A>

impl<A: Ord> StructuralPartialEq for GCounter<A>