Struct flume::Sender

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

A transmitting end of a channel.

Implementations

impl<T: Unpin> Sender<T>

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

Asynchronously send a value into the channel, returning an error if the channel receiver has been dropped. If the channel is bounded and is full, this method will yield to the async runtime.

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

Clones the channel and asynchronously send a value, returning an error if the channel receiver has been dropped. If the channel is bounded and is full, this method will yield to the async runtime.

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

Use this channel as an asynchronous item sink. The returned stream holds a reference to the receiver.

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

Use this channel as an asynchronous item sink. The returned stream has a 'static lifetime.

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 the receiver has 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 the channel receiver has been dropped. If the channel is bounded and is full, this method will block.

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

Send a value into the channel, returning an error if the channel receiver has been dropped or the deadline has passed. If the channel is bounded and is full, this method will block.

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

Send a value into the channel, returning an error if the channel receiver has been dropped or the timeout has expired. If the channel is bounded and is full, this method will block.

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.