Struct remoc_obs::mpsc_replay::ReplayBuffer

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

A buffer that stores and replays values sent to it.

Values sent to the replay channel buffer are stored in an internal buffer. Multiple remote MPSC channels can be subscribed to the replay channel buffer and each channel will receive all values sent to the replay channel buffer, even the values that were received before it was subscribed.

When dropped all channels to the subscribers are closed immediately. Use keep if you want to avoid this.

Implementations

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

pub fn new(rx: Receiver<T>) -> Self

Creates a new replay channel buffer.

The replay channel buffer is fed from the receiver rx.

pub fn new_unbounded(rx: UnboundedReceiver<T>) -> Self

Creates a new replay channel buffer.

The replay channel buffer is fed from the unbounded receiver rx.

pub fn keep(&mut self)

When this replay buffer is dropped, ensures that all outstanding values are sent to the subscribers.

pub fn subscribe<C, B>(&self, tx: Sender<T, C, B>) -> SubscriptionHandle where
    C: Codec,
    B: Size, 

Subscribes a remote MPSC channel to the replay channel buffer.

The channel will receive all values ever sent and future values that will be sent to the replay channel buffer.

The returned SubscriptionHandle can be used to query for errors that occur during sending to the channel.

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn drop(&mut self)

Executes the destructor for this type.