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 async fn closed<'_>(&'_ mut self)

Wait for the associated Receiver handle to drop.

Return

Returns a Future which must be awaited on.

Examples

use tokio::sync::oneshot;

#[tokio::main]
async fn main() {
    let (mut tx, rx) = oneshot::channel::<()>();

    tokio::spawn(async move {
        drop(rx);
    });

    tx.closed().await;
    println!("the receiver dropped");
}

pub fn is_closed(&self) -> bool

Check if the associated Receiver handle has been dropped.

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

Trait Implementations

impl<T> Drop for Sender<T>

fn drop(&mut self)

Executes the destructor for this type.

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

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

Formats the value using the given formatter.