Struct remoc_obs::hash_map::MirroredHashMap

pub struct MirroredHashMap<K, V, Codec = Default> { /* private fields */ }

A hash map that is mirroring an observable hash map.

Implementations

impl<K, V, Codec> MirroredHashMap<K, V, Codec> where
    K: RemoteSend + Eq + Hash + Clone,
    V: RemoteSend + Clone,
    Codec: Codec, 

pub async fn borrow(&self) -> Result<MirroredHashMapRef<'_, K, V>, RecvError>

Returns a reference to the current value of the hash map.

Updates are paused while the read lock is held.

This method returns an error if the observed hash map has been dropped or the connection to it failed before it was marked as done by calling ObservableHashMap::done. In this case the mirrored contents at the point of loss of connection can be obtained using detach.

pub async fn borrow_and_update(
    &mut self
) -> Result<MirroredHashMapRef<'_, K, V>, RecvError>

Returns a reference to the current value of the hash map and marks it as seen.

Thus changed will not return immediately until the value changes after this method returns.

Updates are paused while the read lock is held.

This method returns an error if the observed hash map has been dropped or the connection to it failed before it was marked as done by calling ObservableHashMap::done. In this case the mirrored contents at the point of loss of connection can be obtained using detach.

pub async fn detach(self) -> HashMap<K, V>

Stops updating the hash map and returns its current contents.

pub async fn changed(&mut self)

Waits for a change and marks the newest value as seen.

This also returns when connection to the observed hash map has been lost or the hash map has been marked as done.

pub async fn subscribe(
    &self,
    buffer: usize
) -> Result<HashMapSubscription<K, V, Codec>, RecvError>

Subscribes to change events from this mirrored hash map.

The current contents of the hash map is included with the subscription.

buffer specifies the maximum size of the event buffer for this subscription in number of events. If it is exceeded the subscription is shed and the receiver gets a RecvError::Lagged.

pub async fn subscribe_incremental(
    &self,
    buffer: usize
) -> Result<HashMapSubscription<K, V, Codec>, RecvError>

Subscribes to change events from this mirrored hash map with incremental sending of the current contents.

The current contents of the hash map are sent incrementally.

buffer specifies the maximum size of the event buffer for this subscription in number of events. If it is exceeded the subscription is shed and the receiver gets a RecvError::Lagged.

Trait Implementations

impl<K, V, Codec> Debug for MirroredHashMap<K, V, Codec>

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

Formats the value using the given formatter.

impl<K, V, Codec> Drop for MirroredHashMap<K, V, Codec>

fn drop(&mut self)

Executes the destructor for this type.