piscina 0.1.2

A simple generic pool that supports both sync and async
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

# piscina

A simple generic pool that supports both sync and async.

[![crate_version](https://img.shields.io/crates/v/piscina.svg?style=flat)](https://crates.io/crates/piscina)
[![docs_version](https://img.shields.io/badge/docs-latest-blue.svg?style=flat)](https://docs.rs/fe2o3-amqp/latest/piscina/)

This crate provides a simple generic pool that uses channels instead of locks and supports both sync and async
without dependence on any runtime.

## Features

```toml
default = []
```

The features below are related to logging errors, which should be unreachable.

- `log`: Enables logging using the `log` crate.
- `tracing`: Enables logging using the `tracing` crate.

## Examples

Non-async example:

```rust
use piscina::Pool;

let mut pool = Pool::new();
pool.put(1);
pool.put(2);

let item1 = pool.try_get();
assert!(item1.is_some());

let item2 = pool.blocking_get();

let none = pool.try_get();
assert!(none.is_none());

drop(item1);
let item3 = pool.try_get();
assert!(item3.is_some());
```

Async example:

```rust
use piscina::Pool;

futures::executor::block_on(async {
    let mut pool = Pool::new();
    pool.put(1);
    pool.put(2);

    let item1 = pool.get().await;
    let item2 = pool.get().await;

    let none = pool.try_get();
    assert!(none.is_none());

    drop(item1);
    let item3 = pool.get().await;
});
```

## Safety

Instead of using an `Option`, this crate uses unsafe code `ManuallyDrop` in `PooledItem`.
And the only use of unsafe code `ManuallyDrop::take()` occurs when `PooledItem` is dropped.

License: MIT/Apache-2.0