Struct Sender

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

Available on crate feature dep_flume only.

A transmitting end of a channel.

Implementations

impl<T> Sender<T>

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

Attempt to send a value into the channel. If the channel is bounded and full, or all receivers have been dropped, an error is returned. If the channel associated with this sender is unbounded, this method has the same behaviour as Sender::send.

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

Send a value into the channel, returning an error if all receivers have been dropped. If the channel is bounded and is full, this method will block until space is available or all receivers have been dropped. If the channel is unbounded, this method will not block.

pub fn send_deadline( &self, msg: T, deadline: Instant, ) -> Result<(), SendTimeoutError<T>>

Send a value into the channel, returning an error if all receivers have been dropped or the deadline has passed. If the channel is bounded and is full, this method will block until space is available, the deadline is reached, or all receivers have been dropped.

pub fn send_timeout( &self, msg: T, dur: Duration, ) -> Result<(), SendTimeoutError<T>>

Send a value into the channel, returning an error if all receivers have been dropped or the timeout has expired. If the channel is bounded and is full, this method will block until space is available, the timeout has expired, or all receivers have been dropped.

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: Zero-capacity channels are always empty.

pub fn is_full(&self) -> bool

Returns true if the channel is full. Note: Zero-capacity channels are always 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.

pub fn sender_count(&self) -> usize

Get the number of senders that currently exist, including this one.

pub fn receiver_count(&self) -> usize

Get the number of receivers that currently exist.

Note that this method makes no guarantees that a subsequent send will succeed; it’s possible that between receiver_count() being called and a send(), all open receivers could drop.

pub fn downgrade(&self) -> WeakSender<T>

Creates a WeakSender that does not keep the channel open.

The channel is closed once all Senders are dropped, even if there are still active WeakSenders.

pub fn same_channel(&self, other: &Sender<T>) -> bool

Returns whether the senders are belong to the same channel.

Trait Implementations

impl<T> Clone for Sender<T>

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

Clone this sender. Sender acts as a handle to the ending a channel. Remaining channel contents will only be cleaned up when all senders and the receiver have been dropped.

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> Drop for Sender<T>

fn drop(&mut self)

Executes the destructor for this type.