Struct remoc_obs::hash_map::HashMapSubscription

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

Observable hash map subscription.

This can be sent to a remote endpoint via a remote channel. Then, on the remote endpoint, mirror can be used to build and keep up-to-date a mirror of the observed hash map.

The event stream can also be processed event-wise using recv. If the subscription is not incremental take_initial must be called before the first call to recv.

Implementations

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

pub fn is_incremental(&self) -> bool

Returns whether the subscription is incremental.

pub fn is_complete(&self) -> bool

Returns whether the initial value event or stream of events that build up the initial value has completed or take_initial has been called.

pub fn is_done(&self) -> bool

Returns whether the observed hash map has indicated that no further change events will occur.

pub fn take_initial(&mut self) -> Option<HashMap<K, V>>

Take the initial value.

This is only possible if the subscription is not incremental and the initial value has not already been taken. Otherwise None is returned.

If the subscription is not incremental this must be called before the first call to recv.

pub async fn recv(&mut self) -> Result<Option<HashMapEvent<K, V>>, RecvError>

Receives the next change event.

Panics

Panics when the subscription is not incremental and take_initial has not been called.

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

pub fn mirror(self, max_size: usize) -> MirroredHashMap<K, V, Codec>

Mirror the hash map that this subscription is observing.

max_size specifies the maximum allowed size of the mirrored collection. If this size is reached, processing of events is stopped and RecvError::MaxSizeExceeded is returned.

Trait Implementations

impl<K: Debug, V: Debug, Codec: Debug> Debug for HashMapSubscription<K, V, Codec>

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

Formats the value using the given formatter.

impl<'de, K, V, Codec> Deserialize<'de> for HashMapSubscription<K, V, Codec> where
    K: RemoteSend + Eq + Hash,
    V: RemoteSend,
    Codec: Codec, 

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

Deserialize this value from the given Serde deserializer.

impl<K, V, Codec> Serialize for HashMapSubscription<K, V, Codec> where
    K: RemoteSend + Eq + Hash,
    V: RemoteSend,
    Codec: Codec, 

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

Serialize this value into the given Serde serializer.