Struct futures_channel::mpsc::UnboundedSender

pub struct UnboundedSender<T>(_);

The transmission end of an unbounded mpsc channel.

This value is created by the unbounded function.

Methods

impl<T> UnboundedSender<T>

pub fn poll_ready(&self, _: &mut Context) -> Poll<(), SendError>

Check if the channel is ready to receive a message.

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

pub fn close_channel(&self)

Closes this channel from the sender side, preventing any new messages.

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

Send a message on the channel.

This method should only be called after poll_ready has been used to verify that the channel is ready to receive a message.

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

Sends a message along this channel.

This is an unbounded sender, so this function differs from Sink::send by ensuring the return type reflects that the channel is always ready to receive messages.

Trait Implementations

impl<T: Debug> Debug for UnboundedSender<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Clone> Clone for UnboundedSender<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Drop for UnboundedSender<T>

fn drop(&mut self)

Executes the destructor for this type.