anchored-pool 0.2.0

Bounded and unbounded pools for generic resources or buffers
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

<div align="center" class="rustdoc-hidden">
<h1> Anchored Pool </h1>
</div>

[<img alt="github" src="https://img.shields.io/badge/github-anchored--pool-08f?logo=github" height="20">](https://github.com/robofinch/anchored-leveldb/tree/main/crates/anchored-pool)
[![Latest version](https://img.shields.io/crates/v/anchored-pool.svg)](https://crates.io/crates/anchored-pool)
[![Documentation](https://img.shields.io/docsrs/anchored-pool)](https://docs.rs/anchored-pool/0)
[![Apache 2.0 or MIT license.](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg)](#license)

Provides bounded and unbounded pools for any type of resource, as well as pools specific to
`Vec<u8>` buffers.

The resource pools can have a user-chosen `init_resource` function run to create a new resource,
and whenever a resource is returned to the pool, a `reset_resource` callback is first run.

The buffer pools use these features to create new empty `Vec<u8>` buffers as resources, and
whenever a buffer is returned to the pool, the buffer is either cleared (without changing its
capacity) if its capacity is at most a user-chosen `max_buffer_capacity`, and is otherwise replaced
with a new empty `Vec<u8>`.

# Features

- `kanal` (default): Implement shared (threadsafe) pools using [`kanal`] channels.
- `crossbeam-channel`: Unless the `kanal` feature is enabled, implement shared (threadsafe)
  pools using [`crossbeam-channel`] channels.
- `clone-behavior`: Implements [`clone-behavior`] traits for relevant structs.

If neither of the `kanal` or `crossbeam-channel` features is enabled, a compile-time error
is thrown.

## License

Licensed under either of

* Apache License, Version 2.0 ([LICENSE-APACHE][])
* MIT license ([LICENSE-MIT][])

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in
this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without
any additional terms or conditions.

[LICENSE-APACHE]: ../../LICENSE-APACHE
[LICENSE-MIT]: ../../LICENSE-MIT

[`clone-behavior`]: https://docs.rs/clone-behavior/
[`kanal`]: https://docs.rs/kanal/
[`crossbeam-channel`]: https://docs.rs/crossbeam-channel/