Struct remoc_obs::vec::MirroredVec

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

A vector that is mirroring an observable vector.

Implementations

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

pub async fn borrow(&self) -> Result<MirroredVecRef<'_, T>, RecvError>

Returns a reference to the current value of the vector.

Updates are paused while the read lock is held.

This method returns an error if the observed vector has been dropped or the connection to it failed before it was marked as done by calling ObservableVec::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<MirroredVecRef<'_, T>, RecvError>

Returns a reference to the current value of the vector 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 vector has been dropped or the connection to it failed before it was marked as done by calling ObservableVec::done. In this case the mirrored contents at the point of loss of connection can be obtained using detach.

pub async fn detach(self) -> Vec<T>

Stops updating the vector 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 vector has been lost or the vector has been marked as done.

pub async fn subscribe(
    &self,
    buffer: usize
) -> Result<VecSubscription<T, Codec>, RecvError>

Subscribes to change events from this mirrored vector.

The current contents of the vector 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<VecSubscription<T, Codec>, RecvError>

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

The current contents of the vector 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<T, Codec> Debug for MirroredVec<T, Codec>

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

Formats the value using the given formatter.

impl<T, Codec> Drop for MirroredVec<T, Codec>

fn drop(&mut self)

Executes the destructor for this type.