Struct flume::Sender

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

A transmitting end of a channel.

Implementations

impl<T> Sender<T>

pub fn send_async(&self, item: T) -> SendFut<'_, T>

Asynchronously send a value into the channel, returning an error if all receivers have been dropped. If the channel is bounded and is full, the returned future will yield to the async runtime.

In the current implementation, the returned future will not yield to the async runtime if the channel is unbounded. This may change in later versions.

pub fn into_send_async(self, item: T) -> SendFut<'static, T>

Convert this sender into a future that asynchronously sends a single message into the channel, returning an error if all receivers have been dropped. If the channel is bounded and is full, this future will yield to the async runtime.

In the current implementation, the returned future will not yield to the async runtime if the channel is unbounded. This may change in later versions.

pub fn sink(&self) -> SendSink<'_, T>

Create an asynchronous sink that uses this sender to asynchronously send messages into the channel. The sender will continue to be usable after the sink has been dropped.

In the current implementation, the returned sink will not yield to the async runtime if the channel is unbounded. This may change in later versions.

pub fn into_sink(self) -> SendSink<'static, T>

Convert this sender into a sink that allows asynchronously sending messages into the channel.

In the current implementation, the returned sink will not yield to the async runtime if the channel is unbounded. This may change in later versions.

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.

Trait Implementations

impl<T> Clone for Sender<T>

fn clone(&self) -> Self

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

Formats the value using the given formatter.

impl<T> Drop for Sender<T>

fn drop(&mut self)

Executes the destructor for this type.