Struct CRDTMap 

pub struct CRDTMap<K: Ord + Clone> {
    entries: BTreeMap<K, BTreeMap<Dot, MapValue>>,
    context: CausalContext,
    local_seq: u64,
}

Map CRDT - composable container for nested CRDTs

Maps keys to values, each value is tagged with a dot. A value is “live” if its dot is in the context. A value is “removed” if its dot is in the context but not in the store.

Fields

entries: BTreeMap<K, BTreeMap<Dot, MapValue>>

Maps keys to dots that have been written to this key

context: CausalContext

Shared causal context: all dots that have been created or seen

local_seq: u64

Sequence number for generating dots on this replica

Implementations

impl<K: Ord + Clone> CRDTMap<K>

pub fn new() -> Self

Create a new empty map

pub fn put(&mut self, replica_id: &str, key: K, value: MapValue) -> Dot

Put a value at a key (from this replica)

pub fn get(&self, key: &K) -> Option<&MapValue>

Get the current value at a key Returns the value if the key exists and has live entries

pub fn get_all(&self, key: &K) -> Vec<&MapValue>

Get all values at a key (for concurrent writes)

pub fn remove(&mut self, key: &K)

Remove a key by recording all its current dots as removed

pub fn contains_key(&self, key: &K) -> bool

Check if a key exists with live values

pub fn keys(&self) -> impl Iterator<Item = &K>

Get all keys that have live values

pub fn context(&self) -> &CausalContext

Get the causal context

pub fn put_with_dot(&mut self, key: K, dot: Dot, value: MapValue)

Add a value with a specific dot (for merging)

Trait Implementations

impl<K: Clone + Ord + Clone> Clone for CRDTMap<K>

fn clone(&self) -> CRDTMap<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Ord + Clone> Debug for CRDTMap<K>

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

Formats the value using the given formatter.

impl<K: Ord + Clone> Default for CRDTMap<K>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K: Ord + Clone + Deserialize<'de>> Deserialize<'de> for CRDTMap<K>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K: Ord + Clone> Lattice for CRDTMap<K>

fn join(&self, other: &Self) -> Self

Join operation: merge all entries and contexts For each key, union all the dots and their values

fn bottom() -> Self

The bottom element (identity for join)

fn partial_cmp_lattice(&self, other: &Self) -> Option<Ordering>

Partial order derived from join: a ≤ b iff a ⊔ b = b

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

Check if self ≤ other in the lattice order

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

Join-assign: self = self ⊔ other

impl<K: PartialEq + Ord + Clone> PartialEq for CRDTMap<K>

fn eq(&self, other: &CRDTMap<K>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<K: Ord + Clone + Serialize> Serialize for CRDTMap<K>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<K: Eq + Ord + Clone> Eq for CRDTMap<K>

impl<K: Ord + Clone> StructuralPartialEq for CRDTMap<K>