A thread-safe object pool with automatic return and attach/detach semantics.
The goal of an object pool is to reuse expensive to allocate objects or frequently allocated objects Common use case is when using buffer to read IO.
You would create a pool of size n, containing Vec<u8> that can be used to call something like file.read_to_end(buff).
toml
[dependencies]
object-pool = "0.1"
rust
extern crate object_pool;
Basic usage for pulling from the pool
rust
let pool: Pool<Vec<u8>> = Pool::new(32, || Vec::with_capacity(4096));
let mut reusable_buff = pool.pull().unwrap();
reusable_buff.clear();
some_file.read_to_end(reusable_buff.deref_mut());
//reusable_buff falls out of scope and is returned to the pool
For access across multiple threads simply wrap the pool in an [Arc]
rust
let pool: Arc<Pool<T>> = Pool::new(cap, || T::new());
Check out the [docs] for more info
Here are some performance results from the [benches]
test tests::bench_alloc_128k ... bench: 18 ns/iter (+/- 0)
test tests::bench_alloc_1g ... bench: 4,819 ns/iter (+/- 1,665)
test tests::bench_pull_128k ... bench: 13 ns/iter (+/- 0)
test tests::bench_pull_1g ... bench: 13 ns/iter (+/- 0)
test tests::bench_pull_detach_128k ... bench: 14 ns/iter (+/- 0)
test tests::bench_pull_detach_1g ... bench: 14 ns/iter (+/- 0)
these are not scientific in the slightest, free feel to open an issue about how I can improve these