Skip to main content

CRDTMap

Struct CRDTMap 

Source
pub struct CRDTMap<K: Ord + Clone> { /* private fields */ }
Expand description

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.

Implementations§

Source§

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

Source

pub fn new() -> Self

Create a new empty map

Source

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

Put a value at a key (from this replica)

Source

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

Source

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

Get all values at a key (for concurrent writes)

Source

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

Remove a key by recording all its current dots as removed

Source

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

Check if a key exists with live values

Source

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

Get all keys that have live values

Source

pub fn context(&self) -> &CausalContext

Get the causal context

Source

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

Add a value with a specific dot (for merging)

Trait Implementations§

Source§

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

Source§

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

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<K: Debug + Ord + Clone> Debug for CRDTMap<K>

Source§

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

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

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

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

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

Source§

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

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

Source§

fn bottom() -> Self

The bottom element (identity for join)
Source§

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

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

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

Check if self ≤ other in the lattice order
Source§

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

Join-assign: self = self ⊔ other
Source§

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

Source§

fn eq(&self, other: &CRDTMap<K>) -> 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<K: Ord + Clone + Serialize> Serialize for CRDTMap<K>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

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

Source§

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

Auto Trait Implementations§

§

impl<K> Freeze for CRDTMap<K>

§

impl<K> RefUnwindSafe for CRDTMap<K>
where K: RefUnwindSafe,

§

impl<K> Send for CRDTMap<K>
where K: Send,

§

impl<K> Sync for CRDTMap<K>
where K: Sync,

§

impl<K> Unpin for CRDTMap<K>

§

impl<K> UnwindSafe for CRDTMap<K>
where K: RefUnwindSafe,

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,