Skip to main content

GCounter

Struct GCounter 

Source
pub struct GCounter { /* private fields */ }
Expand description

A grow-only counter (G-Counter).

Each replica maintains its own count. The total value is the sum of all replica counts. This counter can only be incremented, never decremented.

§Example

use crdt_kit::prelude::*;

let mut c1 = GCounter::new(1);
c1.increment();
c1.increment();

let mut c2 = GCounter::new(2);
c2.increment();

c1.merge(&c2);
assert_eq!(c1.value(), 3);

Implementations§

Source§

impl GCounter

Source

pub fn new(actor: NodeId) -> Self

Create a new G-Counter for the given node.

Source

pub fn increment(&mut self)

Increment this replica’s count by 1.

Source

pub fn increment_by(&mut self, n: u64)

Increment this replica’s count by n.

Source

pub fn value(&self) -> u64

Get the total counter value across all replicas.

Source

pub fn actor(&self) -> NodeId

Get this replica’s node ID.

Source

pub fn count_for(&self, actor: NodeId) -> u64

Get the count for a specific node.

Trait Implementations§

Source§

impl Clone for GCounter

Source§

fn clone(&self) -> GCounter

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 Crdt for GCounter

Source§

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

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

impl Debug for GCounter

Source§

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

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

impl DeltaCrdt for GCounter

Source§

type Delta = GCounterDelta

The type of delta produced by this CRDT.
Source§

fn delta(&self, other: &Self) -> GCounterDelta

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

fn apply_delta(&mut self, delta: &GCounterDelta)

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

impl PartialEq for GCounter

Source§

fn eq(&self, other: &GCounter) -> 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 Versioned for GCounter

Source§

const CURRENT_VERSION: u8 = 1

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

const CRDT_TYPE: CrdtType = CrdtType::GCounter

The CRDT type identifier for the envelope.
Source§

impl Eq for GCounter

Source§

impl StructuralPartialEq for GCounter

Auto Trait Implementations§

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.