Struct Sender

pub struct Sender<T>(/* private fields */);

The transmitting end of a channel.

Use bounded or rendezvous to create a channel. You can also convert an UnboundSender into this one.

Implementations

impl<T> Sender<T>

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

Send a value into the channel.

Waits until there is space in the channel buffer.

Returns an error if all receivers have been dropped.

pub async fn send_deadline( &self, msg: T, deadline: impl Into<Deadline>, ) -> Result<(), SendTimeoutError<Option<T>>>

Send a value into the channel.

Waits until there is space in the channel buffer or the deadline is reached.

Returns an error if all receivers have been dropped or the deadline is reached. The msg is lost in case of timeout.

pub fn is_disconnected(&self) -> bool

Returns true if all receivers for this channel have been dropped.

pub fn is_empty(&self) -> bool

Returns true if the channel is empty.

Note: rendezvous channels are always empty.

pub fn is_full(&self) -> bool

Returns true if the channel is full.

Note: rendezvous channels are always full and unbounded channels are never full.

pub fn len(&self) -> usize

Returns the number of messages in the channel.

pub fn capacity(&self) -> Option<usize>

If the channel is bounded, returns its capacity.

Trait Implementations

impl<T> Clone for Sender<T>

fn clone(&self) -> Sender<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Sender<T>

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

Formats the value using the given formatter.

impl<T> From<Sender<T>> for Sender<T>

fn from(s: Sender<T>) -> Sender<T>

Converts to this type from the input type.