Struct futures::channel::oneshot::Sender

[+] Show declaration

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

[−] Expand description

A means of transmitting a single value to another task.

This is created by the channel function.

Methods

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 is returned with the value provided.

pub fn poll_cancel(&mut self, cx: &mut Context) -> Poll<()>[+]

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

Return values

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

If Ok(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 is_canceled(&self) -> bool[+]

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

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

Trait Implementations

impl<T> Unpin for Sender<T>

impl<T> Drop for Sender<T>[+]

[+] Show hidden undocumented items

fn drop(&mut self)[+]

Executes the destructor for this type.

impl<T> Debug for Sender<T> where
    T: Debug, [+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[+]

Formats the value using the given formatter.