README.md
1# Crossbeam Channel
2
3[](
4https://github.com/crossbeam-rs/crossbeam/actions)
5[](
6https://github.com/crossbeam-rs/crossbeam/tree/master/crossbeam-channel#license)
7[](
8https://crates.io/crates/crossbeam-channel)
9[](
10https://docs.rs/crossbeam-channel)
11[](
12https://www.rust-lang.org)
13[](https://discord.com/invite/JXYwgWZ)
14
15This crate provides multi-producer multi-consumer channels for message passing.
16It is an alternative to [`std::sync::mpsc`] with more features and better performance.
17
18Some highlights:
19
20* [`Sender`]s and [`Receiver`]s can be cloned and shared among threads.
21* Two main kinds of channels are [`bounded`] and [`unbounded`].
22* Convenient extra channels like [`after`], [`never`], and [`tick`].
23* The [`select!`] macro can block on multiple channel operations.
24* [`Select`] can select over a dynamically built list of channel operations.
25* Channels use locks very sparingly for maximum [performance](benchmarks).
26
27[`std::sync::mpsc`]: https://doc.rust-lang.org/std/sync/mpsc/index.html
28[`Sender`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/struct.Sender.html
29[`Receiver`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/struct.Receiver.html
30[`bounded`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/fn.bounded.html
31[`unbounded`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/fn.unbounded.html
32[`after`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/fn.after.html
33[`never`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/fn.never.html
34[`tick`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/fn.tick.html
35[`select!`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/macro.select.html
36[`Select`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/struct.Select.html
37
38## Usage
39
40Add this to your `Cargo.toml`:
41
42```toml
43[dependencies]
44crossbeam-channel = "0.5"
45```
46
47## Compatibility
48
49Crossbeam Channel supports stable Rust releases going back at least six months,
50and every time the minimum supported Rust version is increased, a new minor
51version is released. Currently, the minimum supported Rust version is 1.36.
52
53## License
54
55Licensed under either of
56
57 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
58 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
59
60at your option.
61
62#### Contribution
63
64Unless you explicitly state otherwise, any contribution intentionally submitted
65for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
66dual licensed as above, without any additional terms or conditions.
67
68#### Third party software
69
70This product includes copies and modifications of software developed by third parties:
71
72* [examples/matching.rs](examples/matching.rs) includes
73 [matching.go](http://www.nada.kth.se/~snilsson/concurrency/src/matching.go) by Stefan Nilsson,
74 licensed under Creative Commons Attribution 3.0 Unported License.
75
76* [tests/mpsc.rs](tests/mpsc.rs) includes modifications of code from The Rust Programming Language,
77 licensed under the MIT License and the Apache License, Version 2.0.
78
79* [tests/golang.rs](tests/golang.rs) is based on code from The Go Programming Language, licensed
80 under the 3-Clause BSD License.
81
82See the source code files for more details.
83
84Copies of third party licenses can be found in [LICENSE-THIRD-PARTY](LICENSE-THIRD-PARTY).
85
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}