Struct remoc_obs::list::ListSubscription

pub struct ListSubscription<T, Codec = Default> { /* private fields */ }

Observable list 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 list.

The event stream can also be processed event-wise using recv.

Implementations

impl<T, Codec> ListSubscription<T, Codec> where
    T: RemoteSend + Clone,
    Codec: Codec, 

pub fn is_complete(&self) -> bool

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

pub fn is_done(&self) -> bool

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

pub async fn recv(&mut self) -> Result<Option<ListEvent<T>>, RecvError>

Receives the next change event.

impl<T, Codec> ListSubscription<T, Codec> where
    T: RemoteSend + Clone + Sync,
    Codec: Codec, 

pub fn mirror(self, max_size: usize) -> MirroredList<T>

Mirror the list 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<T: Debug, Codec: Debug> Debug for ListSubscription<T, Codec>

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

Formats the value using the given formatter.

impl<'de, T, Codec> Deserialize<'de> for ListSubscription<T, Codec> where
    T: 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<T, Codec> Serialize for ListSubscription<T, Codec> where
    T: 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.