Struct Sender

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

The sending side of a channel.

Implementations

impl<T> Sender<T>

pub fn send_timeout<D>(&self, msg: T, timeout: D) -> Result<(), SendError<T>>

where D: Into<Timeout>,

Waits for a message to be sent into the channel, but only for a limited time.

This call will block until the send operation can proceed or the operation times out.

For unbounded channels, this will perform an allocation (and always send immediately). For bounded channels, no allocation will be performed.

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

Sends a message over the given channel. Waiting if necessary.

For unbounded channels, this will allocate space for a message, and immediately send it. For bounded channels, this will block until a message slot is available, and then send the message.

pub fn try_send(&self, msg: T) -> Result<(), SendError<T>>

Attempts to send a message into the channel without blocking.

This message will either send a message into the channel immediately or return an error if the channel is full. The returned error contains the original message.

impl<T: Unpin> Sender<T>

pub fn send_timeout_async<'a>( &'a self, msg: T, timeout: impl Into<Timeout>, ) -> impl Future<Output = Result<(), SendError<T>>> + 'a

Waits for a message to be sent into the channel, but only for a limited time. Async version.

This has the same behavior as send_timeout, but as an Async function.

pub async fn send_async(&self, msg: T) -> Result<(), SendError<T>>

Sends a message over the given channel, waiting if necessary. Async version.

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.

impl<T> Drop for Sender<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send> Send for Sender<T>

impl<T: Send> Sync for Sender<T>