W3cubDocs

/Rust

Struct std::sync::mpsc::Sender

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

The sending-half of Rust's asynchronous channel type. This half can only be owned by one thread, but it can be cloned to send to other threads.

Messages can be sent through this channel with send.

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);

Methods

impl<T> Sender<T> [src]

[src]

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

impl<T> !Sync for Sender<T> [src]

impl<T> Clone for Sender<T> [src]

[src]

Returns a copy of the value. Read more

[src]

Performs copy-assignment from source. Read more

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

[src]

Executes the destructor for this type. Read more

impl<T> Debug for Sender<T>
1.8.0
[src]

[src]

Formats the value using the given formatter. Read more

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/sync/mpsc/struct.Sender.html