Struct tokio::sync::mpsc::Sender

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

Send values to the associated Receiver.

Instances are created by the channel function.

Methods

impl<T> Sender<T>

pub fn try_send(&mut self, message: T) -> Result<(), TrySendError<T>>

Attempts to send a message on this Sender, returning the message if there was an error.

pub fn send(
    &'_ mut self,
    value: T
) -> impl Future<Output = Result<(), SendError>>

Send a value, waiting until there is capacity.

Examples

In the following example, each call to send will block until the previously sent value was received.

use tokio::sync::mpsc;

#[tokio::main]
async fn main() {
    let (mut tx, mut rx) = mpsc::channel(1);

    tokio::spawn(async move {
        for i in 0..10 {
            if let Err(_) = tx.send(i).await {
                println!("receiver dropped");
                return;
            }
        }
    });

    while let Some(i) = rx.recv().await {
        println!("got = {}", i);
    }
}

Trait Implementations

impl<T> Sink<T> for Sender<T>

type Error = SendError

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Sender<T>>,
    cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(
    self: Pin<&mut Sender<T>>,
    msg: T
) -> Result<(), <Sender<T> as Sink<T>>::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Sender<T>>,
    _cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Sender<T>>,
    _cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

Flush any remaining output and close this sink, if necessary.

impl<T> Clone for Sender<T>

fn clone(&self) -> Sender<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Sender<T>

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

Formats the value using the given formatter.