Struct noosphere_core::data::map::Map

pub struct Map<K, V, A>where
    K: Ord,
    V: Val<A>,
    A: Ord + Hash,{ /* private fields */ }

Map CRDT - Supports Composition of CRDT’s with reset-remove semantics.

Reset-remove means that if one replica removes an entry while another actor concurrently edits that entry, once we sync these two maps, we will see that the entry is still in the map but all edits seen by the removing actor will be gone.

See examples/reset_remove.rs for an example of reset-remove semantics in action.

Implementations

impl<K, V, A> Map<K, V, A>where
    K: Ord,
    V: Val<A>,
    A: Ord + Hash + Clone,

pub fn new() -> Map<K, V, A>

Constructs an empty Map

pub fn is_empty(&self) -> ReadCtx<bool, A>

Returns true if the map has no entries, false otherwise

pub fn len(&self) -> ReadCtx<usize, A>

Returns the number of entries in the Map

pub fn get(&self, key: &K) -> ReadCtx<Option<V>, A>

Retrieve value stored under a key

pub fn update<F>(&self, key: impl Into<K>, ctx: AddCtx<A>, f: F) -> Op<K, V, A>where
    F: FnOnce(&V, AddCtx<A>) -> <V as CmRDT>::Op,

Update a value under some key.

If the key is not present in the map, the updater will be given the result of V::default(). The default value is used to ensure eventual consistency since our Map’s values are CRDTs themselves.

The impl Into<K> bound provides a nice way of providing an input key that can easily convert to the Map’s key. For example, we can call this function with "hello": &str and it can be converted to String.

pub fn rm(&self, key: impl Into<K>, ctx: RmCtx<A>) -> Op<K, V, A>

Remove an entry from the Map

The impl Into<K> bound provides a nice way of providing an input key that can easily convert to the Map’s key. For example, we can call this function with "hello": &str and it can be converted to String.

pub fn read_ctx(&self) -> ReadCtx<(), A>

Retrieve the current read context

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

Gets an iterator over the keys of the Map.

Examples

use crdts::Map;
use crdts::MVReg;
use crdts::CmRDT;

type Actor = &'static str;
type Key = &'static str;

let actor = "actor";

let mut map: Map<i32, MVReg<Key, Actor>, Actor> = Map::new();

let add_ctx = map.read_ctx().derive_add_ctx(actor);
map.apply(map.update(100, add_ctx, |v, a| v.write("foo", a)));

let add_ctx = map.read_ctx().derive_add_ctx(actor);
map.apply(map.update(50, add_ctx, |v, a| v.write("bar", a)));

let add_ctx = map.read_ctx().derive_add_ctx(actor);
map.apply(map.update(200, add_ctx, |v, a| v.write("baz", a)));


let mut keys: Vec<_> = map.keys().map(|key_ctx| *key_ctx.val).collect();

keys.sort();

assert_eq!(keys, &[50, 100, 200]);

pub fn values(&self) -> impl Iterator<Item = ReadCtx<&V, A>>

Gets an iterator over the values of the Map.

Examples

use crdts::Map;
use crdts::MVReg;
use crdts::CmRDT;

type Actor = &'static str;
type Key = &'static str;

let actor = "actor";

let mut map: Map<i32, MVReg<Key, Actor>, Actor> = Map::new();

let add_ctx = map.read_ctx().derive_add_ctx(actor);
map.apply(map.update(100, add_ctx, |v, a| v.write("foo", a)));

let add_ctx = map.read_ctx().derive_add_ctx(actor);
map.apply(map.update(50, add_ctx, |v, a| v.write("bar", a)));

let add_ctx = map.read_ctx().derive_add_ctx(actor);
map.apply(map.update(200, add_ctx, |v, a| v.write("baz", a)));


let mut values: Vec<_> = map
    .values()
    .map(|val_ctx| val_ctx.val.read().val[0])
    .collect();

values.sort();

assert_eq!(values, &["bar", "baz", "foo"]);

pub fn iter(&self) -> impl Iterator<Item = ReadCtx<(&K, &V), A>>

Gets an iterator over the entries of the Map.

Examples

use crdts::Map;
use crdts::MVReg;
use crdts::CmRDT;

type Actor = &'static str;
type Key = &'static str;

let actor = "actor";

let mut map: Map<i32, MVReg<Key, Actor>, Actor> = Map::new();

let add_ctx = map.read_ctx().derive_add_ctx(actor);
map.apply(map.update(100, add_ctx, |v, a| v.write("foo", a)));

let add_ctx = map.read_ctx().derive_add_ctx(actor);
map.apply(map.update(50, add_ctx, |v, a| v.write("bar", a)));

let add_ctx = map.read_ctx().derive_add_ctx(actor);
map.apply(map.update(200, add_ctx, |v, a| v.write("baz", a)));


let mut items: Vec<_> = map
    .iter()
    .map(|item_ctx| (*item_ctx.val.0, item_ctx.val.1.read().val[0]))
    .collect();

items.sort();

assert_eq!(items, &[(50, "bar"), (100, "foo"), (200, "baz")]);

Trait Implementations

impl<K, V, A> Clone for Map<K, V, A>where
    K: Clone + Ord,
    V: Clone + Val<A>,
    A: Clone + Ord + Hash,

fn clone(&self) -> Map<K, V, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V, A> CmRDT for Map<K, V, A>where
    K: Ord,
    V: Val<A> + Debug,
    A: Ord + Hash + Clone + Debug,

type Op = Op<K, V, 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 = CmRDTValidation<V, A>

The validation error returned by validate_op.

fn validate_op(
    &self,
    op: &<Map<K, V, A> as CmRDT>::Op
) -> Result<(), <Map<K, V, A> as CmRDT>::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: <Map<K, V, A> as CmRDT>::Op)

Apply an Op to the CRDT

impl<K, V, A> CvRDT for Map<K, V, A>where
    K: Ord + Clone + Debug,
    V: Val<A> + CvRDT + Debug,
    A: Ord + Hash + Clone + Debug,

type Validation = CvRDTValidation<K, V, A>

The validation error returned by validate_merge.

fn validate_merge(
    &self,
    other: &Map<K, V, A>
) -> Result<(), <Map<K, V, A> as CvRDT>::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: Map<K, V, A>)

Merge the given CRDT into the current CRDT.

impl<K, V, A> Debug for Map<K, V, A>where
    K: Debug + Ord,
    V: Debug + Val<A>,
    A: Debug + Ord + Hash,

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

Formats the value using the given formatter.

impl<K, V, A> Default for Map<K, V, A>where
    K: Ord,
    V: Val<A>,
    A: Ord + Hash,

fn default() -> Map<K, V, A>

Returns the “default value” for a type.

impl<'de, K, V, A> Deserialize<'de> for Map<K, V, A>where
    K: Ord + Deserialize<'de>,
    V: Val<A> + Deserialize<'de>,
    A: Ord + Hash + Deserialize<'de>,

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Map<K, V, A>, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K, V, A> PartialEq<Map<K, V, A>> for Map<K, V, A>where
    K: PartialEq<K> + Ord,
    V: PartialEq<V> + Val<A>,
    A: PartialEq<A> + Ord + Hash,

fn eq(&self, other: &Map<K, 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<K, V, A> ResetRemove<A> for Map<K, V, A>where
    K: Ord,
    V: Val<A>,
    A: Ord + Hash,

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

Remove data that is strictly smaller than this clock

impl<K, V, A> Serialize for Map<K, V, A>where
    K: Ord + Serialize,
    V: Val<A> + Serialize,
    A: Ord + Hash + Serialize,

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<K, V, A> Eq for Map<K, V, A>where
    K: Eq + Ord,
    V: Eq + Val<A>,
    A: Eq + Ord + Hash,

impl<K, V, A> StructuralEq for Map<K, V, A>where
    K: Ord,
    V: Val<A>,
    A: Ord + Hash,

impl<K, V, A> StructuralPartialEq for Map<K, V, A>where
    K: Ord,
    V: Val<A>,
    A: Ord + Hash,