Struct futures_channel::oneshot::Sender

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

A means of transmitting a single value to another task.

This is created by the channel function.

Implementations

impl<T> Sender<T>

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

Completes this oneshot with a successful result.

This function will consume self and indicate to the other end, the Receiver, that the value provided is the result of the computation this represents.

If the value is successfully enqueued for the remote end to receive, then Ok(()) is returned. If the receiving end was dropped before this function was called, however, then Err(t) is returned.

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 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> Unpin for Sender<T>