Struct Sender

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

The transmission end of a channel.

This is created by the channel function.

Implementations

impl<T> Sender<T>

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

Sends the provided message along this channel.

pub fn close(&self)

Closes the sender half

This prevents any further messages from being sent on the channel while still enabling the receiver to drain messages that are buffered.

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

Trait Implementations

impl<T> Clone for Sender<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> 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.

impl<T> Sink<T> for Sender<T>

type Error = SendError<T>

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

fn poll_ready( self: Pin<&mut Self>, _: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), SendError<T>>

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_flush( self: Pin<&mut Self>, _: &mut Context<'_>, ) -> Poll<Result<(), SendError<T>>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, _: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

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

impl<T> Unpin for Sender<T>