Struct remoc_obs::list::ObservableList

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

An append-only list that emits an event for each change.

Use subscribe to obtain an event stream that can be used for building a mirror of this list.

The distributor method can be used to obtain a clonable object that can be used to make subscriptions from other tasks.

Implementations

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

pub fn new() -> Self

Creates a new, empty observable list.

pub fn set_error_handler<E>(&mut self, on_err: E) where
    E: Fn(SendError) + Send + Sync + 'static, 

Sets the error handler function that is called when sending an event fails.

pub fn distributor(&self) -> ObservableListDistributor<T, Codec>

Returns an observable list distributor that can be used to make subscriptions to this observable list.

It is clonable and can be sent to other tasks.

pub fn subscribe(&self) -> ListSubscription<T, Codec>

Subscribes to the observable list with incremental sending of the current contents.

pub fn subscriber_count(&self) -> usize

Current number of subscribers.

pub fn closed(&self) -> impl Future<Output = ()>

Returns when all subscribers have quit.

If no subscribers are currently present, this return immediately. This also returns when done has been called and all subscribers have received all elements of the list.

pub fn is_closed(&self) -> bool

Returns true if there are currently no subscribers.

pub fn push(&mut self, value: T)

Appends an element at the end.

A ListEvent::Push change event is sent.

Panics

Panics when done has been called before.

pub fn len(&self) -> usize

The current number of elements in the observable list.

pub fn is_empty(&self) -> bool

Returns whether this observable list is empty.

pub fn done(&mut self)

Prevents further changes of this list and notifies are subscribers that no further events will occur.

Methods that modify the list will panic after this has been called. It is still possible to subscribe to this observable list.

pub fn is_done(&self) -> bool

Returns true if done has been called and further changes are prohibited.

Methods that modify the list will panic in this case.

pub async fn borrow<'a>(&'a self) -> ObservableListRef<'a, T>

Borrows the current value of the observable list.

While the borrow is held sending of events to subscribers is paused.

Trait Implementations

impl<T, Codec> Debug for ObservableList<T, Codec>

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

Formats the value using the given formatter.

impl<T, Codec> Default for ObservableList<T, Codec> where
    T: RemoteSend + Clone,
    Codec: Codec, 

fn default() -> Self

Returns the “default value” for a type.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<T, Codec> Extend<T> for ObservableList<T, Codec> where
    T: RemoteSend + Clone,
    Codec: Codec, 

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T, Codec> From<Vec<T, Global>> for ObservableList<T, Codec> where
    T: RemoteSend + Clone,
    Codec: Codec, 

fn from(initial: Vec<T>) -> Self

Performs the conversion.