Skip to main content

ORMap

Struct ORMap 

Source
pub struct ORMap<K, V: Merge + Default + Clone> { /* private fields */ }
Expand description

An observed-remove map with nested CRDT values.

Keys are managed with OR-Set add-wins semantics. Values are merged using their CRDT merge function.

Implementations§

Source§

impl<K: Hash + Eq + Clone, V: Merge + Default + Clone> ORMap<K, V>

Source

pub fn new(replica_id: ReplicaId) -> Self

Create a new map with a specific replica ID.

Source

pub fn new_random() -> Self

Create a new map with a random replica ID.

Source

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

Get a reference to a value if the key exists.

Source

pub fn get_or_insert(&mut self, key: K) -> &mut V

Get a mutable reference to a value, creating the key if necessary. Always creates a new dot to ensure add-wins semantics.

Source

pub fn get_mut(&mut self, key: &K) -> Option<&mut V>

Get a mutable reference to a value without creating a new dot. Use this for read-heavy access patterns where add-wins isn’t needed.

Source

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

Check if a key exists in the map.

Source

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

Remove a key from the map.

Source

pub fn len(&self) -> usize

Get the number of keys.

Source

pub fn is_empty(&self) -> bool

Check if the map is empty.

Source

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

Iterate over active keys.

Source

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

Iterate over key-value pairs.

Trait Implementations§

Source§

impl<K: Clone, V: Clone + Merge + Default + Clone> Clone for ORMap<K, V>

Source§

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

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, V: Debug + Merge + Default + Clone> Debug for ORMap<K, V>

Source§

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

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

impl<K: Hash + Eq + Clone, V: Merge + Default + Clone> Default for ORMap<K, V>

Source§

fn default() -> Self

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

impl<K: Hash + Eq + Clone + Serialize + DeserializeOwned + Send + 'static, V: Merge + Default + Clone + Serialize + DeserializeOwned + Send + 'static> DeltaCrdt for ORMap<K, V>

Source§

type Delta = ORMapDelta<K, V>

The type of delta this CRDT produces.
Source§

fn delta_since(&self, since: &VClock) -> Option<Self::Delta>

Extract a delta containing changes since the given version. Read more
Source§

fn apply_delta(&mut self, delta: &Self::Delta)

Apply an incoming delta to this CRDT.
Source§

fn version(&self) -> VClock

Get the current version (vector clock) of this CRDT.
Source§

impl<'de, K, V> Deserialize<'de> for ORMap<K, V>

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: Hash + Eq + Clone, V: Merge + Default + Clone> Merge for ORMap<K, V>

Source§

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

Merge another instance into self. Read more
Source§

impl<K, V> Serialize for ORMap<K, V>

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

Auto Trait Implementations§

§

impl<K, V> Freeze for ORMap<K, V>

§

impl<K, V> RefUnwindSafe for ORMap<K, V>

§

impl<K, V> Send for ORMap<K, V>
where K: Send, V: Send,

§

impl<K, V> Sync for ORMap<K, V>
where K: Sync, V: Sync,

§

impl<K, V> Unpin for ORMap<K, V>
where K: Unpin, V: Unpin,

§

impl<K, V> UnsafeUnpin for ORMap<K, V>

§

impl<K, V> UnwindSafe for ORMap<K, V>
where K: UnwindSafe, V: UnwindSafe,

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,