Struct Sender

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

A sender part of the channel.

Implementations

impl<T> Sender<T>

pub fn send(self, t: T) -> Result<(), T>

Consume the sender and queue up an item to send.

This method returns right away and never blocks, there is no guarantee though that the message is received by the other end.

pub fn send_and_wait(self, t: T) -> impl Future<Output = Result<(), ()>>

Consume the sender and send an item.

The returned future will resolve when the message is received on the other end. Note that polling the future is actually not required to send the message as that happens synchronously. The future resolves to error in case the receiving end was dropped before being able to process the message.

Methods from Deref<Target = Sender<T>>

pub fn poll_canceled(&mut self, cx: &mut Context<'_>) -> Poll<()>

Polls this Sender half to detect whether its associated Receiver has been dropped.

Return values

If Ready(()) is returned then the associated Receiver has been dropped, which means any work required for sending should be canceled.

If Pending is returned then the associated Receiver is still alive and may be able to receive a message if sent. The current task, however, is scheduled to receive a notification if the corresponding Receiver goes away.

pub fn cancellation(&mut self) -> Cancellation<'_, T>

Creates a future that resolves when this Sender’s corresponding Receiver half has hung up.

This is a utility wrapping poll_canceled to expose a Future.

pub fn is_canceled(&self) -> bool

Tests to see whether this Sender’s corresponding Receiver has been dropped.

Unlike poll_canceled, this function does not enqueue a task for wakeup upon cancellation, but merely reports the current state, which may be subject to concurrent modification.

pub fn is_connected_to(&self, receiver: &Receiver<T>) -> bool

Tests to see whether this Sender is connected to the given Receiver. That is, whether they were created by the same call to channel.

Trait Implementations

impl<T: Debug> Debug for Sender<T>

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

Formats the value using the given formatter.

impl<T> DerefMut for Sender<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Deref for Sender<T>

type Target = Sender<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.