Struct tokio_sync::oneshot::Sender

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

Sends a value to the associated Receiver.

Instances are 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.

The function consumes self and notifies the Receiver handle that a value is ready to be received.

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_close(&mut self) -> Poll<(), ()>

Check if the associated Receiver handle 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(NotReady) is returned then the associated Receiver is still alive and may be able to receive a message if sent. The current task is registered to receive a notification if the Receiver handle goes away.

pub fn is_closed(&self) -> bool

Check if the associated Receiver handle has been dropped.

Unlike poll_close, this function does not register a task for wakeup upon close.

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

fn drop(&mut self)

Executes the destructor for this type.