Struct radiorust::flow::Sender

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

Sender that can be dynamically connected to a Receiver

To send data to the connected Receivers, use Sender::send. Call Sender::reset to indicate missing data and Sender::finish to indicate end of stream.

Connecting the Sender to a Receiver is done by passing a SenderConnector reference to ReceiverConnector::connect. The SenderConnector is obtained when calling new_sender.

There is buffer capacity of 1 for each Sender, i.e. Sender::send completes immediately for the first value sent or after all Receivers have received the previous value. (Note: In some cases, Sender::send may wait until receiving is attempted by one Receiver. This is because the broadcast_bp::Sender might not see a broadcast_bp::Receiver as subscriber yet.)

Implementations

impl<T> Sender<T>

pub async fn reserve(&self) -> Result<Reservation<'_, T>, RsrvError>

Wait until ready to send

The returned Reservation handle may be used to send a value immediately (through Reservation::send, which is not async).

pub fn try_reserve(&self) -> Result<Option<Reservation<'_, T>>, RsrvError>

Check if ready to send

The returned Reservation handle may be used to send a value immediately (through Reservation::send, which is not async).

This method returns Ok(None) if it’s not possible to send a value immediately.

pub async fn send(&self, value: T) -> Result<(), SendError<T>>

Send data to all Receivers which have been connected

pub async fn reset(&self) -> Result<(), SendError<()>>

Notify all Receivers that some data is missing or that the data stream has been restarted

pub async fn finish(&self) -> Result<(), SendError<()>>

Notify all Receivers that the data stream has been completed

pub async fn forward_error(&self, error: RecvError) -> Result<(), SendError<()>>

Propagate a RecvError to all Receivers

RecvError::Closed is mapped to RecvError::Reset because a Receiver may be reconnected with another Sender later.

Trait Implementations

impl<T> Clone for Sender<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Sender<T>

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

Formats the value using the given formatter.