Struct remoc_obs::list::MirroredList

pub struct MirroredList<T> { /* private fields */ }

An append-only list that is mirroring an observable append-only list.

Clones of this are cheap and share the same underlying mirrored list.

Implementations

impl<T> MirroredList<T> where
    T: RemoteSend + Clone, 

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

Returns a reference to the current value of the list.

Updates are paused while the read lock is held.

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

Returns a reference to the current value of the list 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 list has been dropped or the connection to it failed before it was marked as done by calling ObservableList::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 list and returns its current contents.

If clones of this mirrored list exist, the cloned contents are returned.

pub async fn changed(&mut self)

Waits for a change (append of one or more elements) and marks the newest value as seen.

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

Trait Implementations

impl<T: Clone> Clone for MirroredList<T>

fn clone(&self) -> MirroredList<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for MirroredList<T>

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

Formats the value using the given formatter.

impl<T> Drop for MirroredList<T>

fn drop(&mut self)

Executes the destructor for this type.