mpsc 0.3.0

mpsc channel
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

# mpsc


<!-- Badges placeholder -->


English | [简体中文](./README-CN.md)

*mpsc* provides Multiple Producer Single Consumer channels built on top of `queue-ext`. Supports multiple backing queue implementations, each with different characteristics.

## Features


- **SegQueue** channel — lock-free, crossbeam-based (default)
- **VecDeque** channel — standard Rust VecDeque backed
- **Priority** channel — items prioritized by key order
- **IndexMap** channel — deduplication by key (last write wins)
- Thread-safe `Sender`/`Receiver` types
- Single-threaded `LocalSender`/`LocalReceiver` variants
- `Sink` and `Stream` trait implementations
- Type-erased channel API

## Cargo Feature Flags


| Feature | Description | Default |
|---|---|---|
| `segqueue` | Lock-free channel via `crossbeam::SegQueue` | **yes** |
| `vecdeque` | Channel backed by `std::collections::VecDeque` | no |
| `priority` | Priority channel via `box-collections::PriorityQueue` | no |
| `indexmap` | Deduplicating channel via `indexmap::IndexMap` | no |

## Basic Usage


```rust
use mpsc::segqueue_channel;
use futures::executor::block_on;

let (mut tx, mut rx) = segqueue_channel(10);
block_on(tx.send(42)).unwrap();
assert_eq!(block_on(rx.recv()), Some(42));
```

## More Examples


- [channel-test.rs](https://github.com/try-box/rust-box/blob/main/examples/src/channel-test.rs)

## Tests


```bash
cargo test -p mpsc --features "segqueue,vecdeque,priority,indexmap"
```

37 tests covering all 4 channel types, LocalSender/Receiver, clone, and drop semantics.

## License


Licensed under either of Apache License 2.0 or MIT license at your option.