loole 0.1.4

A safe async/sync multi-producer, multi-consumer 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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# Loole

A safe async/sync multi-producer multi-consumer channel.

![Github Actions](https://github.com/mahdi-shojaee/loole/actions/workflows/rust.yml/badge.svg?branch=master)
[![Documentation](https://docs.rs/loole/badge.svg)](https://docs.rs/loole)
[![Cargo](https://img.shields.io/crates/v/loole.svg)](https://crates.io/crates/loole)
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](https://github.com/mahdi-shojaee/loole)

Producers can send and consumers can receive messages asynchronously or synchronously:

- `sync -> sync`
- `async -> async`
- `sync -> async`
- `async -> sync`

```rust
fn main() {
    let (tx, rx) = loole::unbounded();

    std::thread::spawn(move || {
        for i in 0..10 {
            tx.send(i).unwrap();
        }
    });

    let mut sum = 0;
    while let Ok(i) = rx.recv() {
        sum += i;
    }

    assert_eq!(sum, (0..10).sum());
}
```

## Usage

To use Loole, place the following line under the `[dependencies]` section in your `Cargo.toml`:

```toml
loole = "0.1.4"
```

## Benchmarks

Benchmarks measure throughput, which is the number of messages sent and received per second, for messages of 264 bytes each.

### Run benchmarks

To run benchmarks on your local machine, run the following command:

```bash
cargo run --release -p benchmark
```

The above command will generate and update the benchmark images in the README.md file.

### MPSC

Measures: Messages per seconds. (higher is better)

Messages size: 264 bytes.

![MPSC: sync-sync](benchmark/charts/images/mpsc-sync-sync.svg)
![MPSC: async-async](benchmark/charts/images/mpsc-async-async.svg)
![MPSC: async-sync](benchmark/charts/images/mpsc-async-sync.svg)
![MPSC: sync-async](benchmark/charts/images/mpsc-sync-async.svg)

### MPMC

Measures: Messages per seconds. (higher is better)

Messages size: 264 bytes.

![MPMC: sync-sync](benchmark/charts/images/mpmc-sync-sync.svg)
![MPMC: async-async](benchmark/charts/images/mpmc-async-async.svg)
![MPMC: async-sync](benchmark/charts/images/mpmc-async-sync.svg)
![MPMC: sync-async](benchmark/charts/images/mpmc-sync-async.svg)

### SPSC

Measures: Messages per seconds. (higher is better)

Messages size: 264 bytes.

![SPSC: sync-sync](benchmark/charts/images/spsc-sync-sync.svg)
![SPSC: async-async](benchmark/charts/images/spsc-async-async.svg)
![SPSC: async-sync](benchmark/charts/images/spsc-async-sync.svg)
![SPSC: sync-async](benchmark/charts/images/spsc-sync-async.svg)

## License

Loole is licensed under either of:

- Apache License 2.0, (http://www.apache.org/licenses/LICENSE-2.0)

- MIT license (http://opensource.org/licenses/MIT)