tub 0.3.7

Async Pool
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

# Tub 🛁

[<img alt="github" src="https://img.shields.io/badge/github-wcygan/tub-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/wcygan/tub)
[<img alt="crates.io" src="https://img.shields.io/crates/v/tub.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/tub)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-tub-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/tub)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/wcygan/tub/test.yml?branch=master&style=for-the-badge" height="20">](https://github.com/wcygan/tub/actions?query=branch%3Amaster)
[![codecov](https://codecov.io/gh/wcygan/tub/branch/master/graph/badge.svg?token=5OGDYMYGXM)](https://codecov.io/gh/wcygan/tub)


A *blazingly fast* object pool for Rust.

Values are retrieved from the pool asynchronously. When the retrieved value goes out of scope, the value is returned to the pool.

## Documentation

Read about the public API: [docs.rs/tub](https://docs.rs/tub)

Read about the design: [wcygan.io/post/pools](https://www.wcygan.io/post/pools/)

## Usage

To use Tub, add this to your Cargo.toml:

```toml
[dependencies]
tub = "0.3.7"
```

Then create and use a pool like so:

```rust
use tub::Pool;

#[tokio::main]
async fn main() {
   // Create a pool
   let pool: Pool<Box> = (0..10)
       .map(|_| Box { value: 123 })
       .into();

   // Get a value from the pool
   let mut box1 = pool.acquire().await;

   // Use the value
   box1.foo();

   // Modify the value
   *box1 = Box { value: 456 };

   // Return the value to the pool
   drop(box1);
}

struct Box {
  value: u32
}

impl Box {
  fn foo(&mut self) { }
}
```

## Benchmarks

In the ["Pools"](https://www.wcygan.io/post/pools/#results) blog post I benchmarked Tub against other object pools in Rust.

The benchmarks help us understand how efficient the underlying mechanisms for concurrency control, object storage, and object reuse are.

The results are as follows:

### Input-based comparison

The following benchmarks compare the performance of different pools under different amounts of load:

![all](resources/all.svg)

![two](resources/two.svg)

### 100,000 acquires & releases

The following benchmarks compare the performance of running 100,000 acquire & release operations across tasks.

### [Tub](https://crates.io/crates/tub)

![tub](resources/tub-pdf.svg)

### [Async Object Pool](https://crates.io/crates/async-object-pool)

![async-object-pool](resources/async-object-pool-pdf.svg)

### [Simple Pool](https://crates.io/crates/simple-pool)

![simple-pool](resources/simple-pool-pdf.svg)