Struct UnboundedSender

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

The sender of an unbounded mpsc channel.

This value is created by the unbounded function.

Implementations

impl<T> UnboundedSender<T>

pub fn send_now(&self, item: T) -> Result<(), SendError<T>>

Sends a value to the unbounded receiver.

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

pub fn close_now(&self)

Closes the channel.

Every sender (dropped or not) is considered closed when this method is called.

Trait Implementations

impl<T> 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> Debug for UnboundedSender<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Drop for UnboundedSender<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Sink<T> for &UnboundedSender<T>

type Error = TrySendError

The type of value produced by the sink when an error occurs.

fn start_send( self: Pin<&mut &UnboundedSender<T>>, item: T, ) -> Result<(), <&UnboundedSender<T> as Sink<T>>::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_ready( self: Pin<&mut &UnboundedSender<T>>, _cx: &mut Context<'_>, ) -> Poll<Result<(), <&UnboundedSender<T> as Sink<T>>::Error>>

Attempts to prepare the Sink to receive a value.

fn poll_flush( self: Pin<&mut &UnboundedSender<T>>, _cx: &mut Context<'_>, ) -> Poll<Result<(), <&UnboundedSender<T> as Sink<T>>::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut &UnboundedSender<T>>, _cx: &mut Context<'_>, ) -> Poll<Result<(), <&UnboundedSender<T> as Sink<T>>::Error>>

Flush any remaining output and close this sink, if necessary.