pub struct GenericStateBroadcastChannel<MutexType: RawMutex, T> { /* private fields */ }Expand description
A channel which can be used to synchronize the state between a sender an arbitrary number of receivers.
The sender can publish its state.
The receivers can wait for state updates by announcing the most recent state that is already known to them.
Implementations
sourceimpl<MutexType: RawMutex, T> GenericStateBroadcastChannel<MutexType, T>where
T: Clone,
impl<MutexType: RawMutex, T> GenericStateBroadcastChannel<MutexType, T>where
T: Clone,
sourcepub fn new() -> GenericStateBroadcastChannel<MutexType, T>where
T: Clone,
pub fn new() -> GenericStateBroadcastChannel<MutexType, T>where
T: Clone,
Creates a new State Broadcast Channel in the given state
sourcepub fn send(&self, value: T) -> Result<(), ChannelSendError<T>>
pub fn send(&self, value: T) -> Result<(), ChannelSendError<T>>
Writes a single value to the channel.
This will notify waiters about the availability of the value. If the maximum amount of values had been written to the channel, or if the channel is closed, the new value will be rejected and returned inside the error variant.
sourcepub fn close(&self) -> CloseStatus
pub fn close(&self) -> CloseStatus
Closes the channel.
This will notify waiters about closure, by fulfilling pending Futures
with None.
send(value) attempts which follow this call will fail with a
ChannelSendError.
sourcepub fn receive(&self, state_id: StateId) -> StateReceiveFuture<'_, MutexType, T>ⓘNotable traits for StateReceiveFuture<'a, MutexType, T>impl<'a, MutexType, T: Clone> Future for StateReceiveFuture<'a, MutexType, T> type Output = Option<(StateId, T)>;
pub fn receive(&self, state_id: StateId) -> StateReceiveFuture<'_, MutexType, T>ⓘNotable traits for StateReceiveFuture<'a, MutexType, T>impl<'a, MutexType, T: Clone> Future for StateReceiveFuture<'a, MutexType, T> type Output = Option<(StateId, T)>;
Returns a future that gets fulfilled when a value is written to the channel
or the channel is closed.
state_id specifies the minimum state ID that should be retrieved
by the receive operation.
The returned StateReceiveFuture will get fulfilled with the
retrieved value as well as the StateId which is required to retrieve
the following state.
sourcepub fn try_receive(&self, state_id: StateId) -> Option<(StateId, T)>
pub fn try_receive(&self, state_id: StateId) -> Option<(StateId, T)>
Attempt to retrieve a value whose StateId is greater than the one provided.
Returns None if no value is found in the channel, or if the current StateId
of the value is less or equal to the one provided.