crossbeam-channel 0.1.2

Multi-producer multi-consumer channels for message passing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# Multi-producer multi-consumer channels for message passing

[![Build Status](https://travis-ci.org/crossbeam-rs/crossbeam-channel.svg?branch=master)](https://travis-ci.org/crossbeam-rs/crossbeam-channel)
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](https://github.com/crossbeam-rs/crossbeam-channel)
[![Cargo](https://img.shields.io/crates/v/crossbeam-channel.svg)](https://crates.io/crates/crossbeam-channel)
[![Documentation](https://docs.rs/crossbeam-channel/badge.svg)](https://docs.rs/crossbeam-channel)

Channels are concurrent FIFO queues used for passing messages between threads.

Crossbeam's channels are an alternative to the [`std::sync::mpsc`] channels
provided by the standard library. They are an improvement in pretty much all
aspects: ergonomics, flexibility, features, performance.

[`std::sync::mpsc`]: https://doc.rust-lang.org/std/sync/mpsc/index.html

Read the original [RFC](https://github.com/crossbeam-rs/rfcs/pull/22) that introduced these
channels for more information on their design and implementation.

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
crossbeam-channel = "0.1"
```

Next, add this to your crate:

```rust
extern crate crossbeam_channel;
```

## Comparison with `std::sync::mpsc`

|                                  | `std::sync::mpsc`                  | `crossbeam-channel`                               |
|----------------------------------|------------------------------------|---------------------------------------------------|
| Unbounded channel constructor    | `channel()`                        | `unbounded()`                                     |
| Bounded channel constructor      | `sync_channel(cap)`                | `bounded(cap)`                                    |
| Sender types                     | `Sender` and `SyncSender`          | `Sender`                                          |
| Receiver types                   | `Receiver`                         | `Receiver`                                        |
| Sender implements `Sync`?        | No                                 | Yes                                               |
| Receiver implements `Sync`?      | No                                 | Yes                                               |
| Sender implements `Clone`?       | Yes                                | Yes                                               |
| Receiver implements `Clone`?     | No                                 | Yes                                               |
| Sender operations                | `try_send`, `send`                 | `try_send`, `send`, `send_timeout`                |
| Receiver operations              | `try_recv`, `recv`, `recv_timeout` | `try_recv`, `recv`, `recv_timeout`                |
| Additional sender methods        |                                    | `is_empty`, `len`, `capacity`                     |
| Additional receiver methods      | `iter`, `try_iter`                 | `iter`, `try_iter`, `is_empty`, `len`, `capacity` |
| Selection macro                  | `select!`                          | `select_loop!`                                    |
| Select interface                 | `std::sync::mpsc::Select`          | `crossbeam_channel::Select`                       |
| Select has a safe interface?     | No                                 | Yes                                               |
| Select supports send operations? | No                                 | Yes                                               |
| Select can have a timeout?       | No                                 | Yes                                               |
| Select can be non-blocking?      | No                                 | Yes                                               |

## License

Licensed under the terms of MIT license and the Apache License (Version 2.0).

See [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) for details.