README.md
1# Crossbeam Queue
2
3[](
4https://github.com/crossbeam-rs/crossbeam/actions)
5[](
6https://github.com/crossbeam-rs/crossbeam/tree/master/crossbeam-queue#license)
7[](
8https://crates.io/crates/crossbeam-queue)
9[](
10https://docs.rs/crossbeam-queue)
11[](
12https://www.rust-lang.org)
13[](https://discord.com/invite/JXYwgWZ)
14
15This crate provides concurrent queues that can be shared among threads:
16
17* [`ArrayQueue`], a bounded MPMC queue that allocates a fixed-capacity buffer on construction.
18* [`SegQueue`], an unbounded MPMC queue that allocates small buffers, segments, on demand.
19
20Everything in this crate can be used in `no_std` environments, provided that `alloc` feature is
21enabled.
22
23[`ArrayQueue`]: https://docs.rs/crossbeam-queue/*/crossbeam_queue/struct.ArrayQueue.html
24[`SegQueue`]: https://docs.rs/crossbeam-queue/*/crossbeam_queue/struct.SegQueue.html
25
26## Usage
27
28Add this to your `Cargo.toml`:
29
30```toml
31[dependencies]
32crossbeam-queue = "0.3"
33```
34
35## Compatibility
36
37Crossbeam Queue supports stable Rust releases going back at least six months,
38and every time the minimum supported Rust version is increased, a new minor
39version is released. Currently, the minimum supported Rust version is 1.36.
40
41## License
42
43Licensed under either of
44
45 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
46 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
47
48at your option.
49
50#### Contribution
51
52Unless you explicitly state otherwise, any contribution intentionally submitted
53for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
54dual licensed as above, without any additional terms or conditions.
55
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}