Struct std::sync::mpsc::Sender

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

The sending-half of Rust’s asynchronous channel type.

Messages can be sent through this channel with send.

Note: all senders (the original and its clones) need to be dropped for the receiver to stop blocking to receive messages with Receiver::recv.

Examples

use std::sync::mpsc::channel;
use std::thread;

let (sender, receiver) = channel();
let sender2 = sender.clone();

// First thread owns sender
thread::spawn(move || {
    sender.send(1).unwrap();
});

// Second thread owns sender2
thread::spawn(move || {
    sender2.send(2).unwrap();
});

let msg = receiver.recv().unwrap();
let msg2 = receiver.recv().unwrap();

assert_eq!(3, msg + msg2);

Implementations

impl<T> Sender<T>

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

Attempts to send a value on this channel, returning it back if it could not be sent.

A successful send occurs when it is determined that the other end of the channel has not hung up already. An unsuccessful send would be one where the corresponding receiver has already been deallocated. Note that a return value of Err means that the data will never be received, but a return value of Ok does not mean that the data will be received. It is possible for the corresponding receiver to hang up immediately after this function returns Ok.

This method will never block the current thread.

Examples

use std::sync::mpsc::channel;

let (tx, rx) = channel();

// This send is always successful
tx.send(1).unwrap();

// This send will fail because the receiver is gone
drop(rx);
assert_eq!(tx.send(1).unwrap_err().0, 1);

Trait Implementations

impl<T> Clone for Sender<T>

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

Clone a sender to send to other threads.

Note, be aware of the lifetime of the sender because all senders (including the original) need to be dropped in order for Receiver::recv to stop blocking.

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

Performs copy-assignment from source.

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: Send> Send for Sender<T>

impl<T: Send> Sync for Sender<T>