#vector #buffer #region #backed #contiguous #borrow #mutable

bufferpool

A vector of vectors backed by one contiguous vector - allows mutable borrows of non-overlapping regions

7 releases

0.1.7 Dec 26, 2019
0.1.6 Dec 17, 2019

#2453 in Algorithms

21 downloads per month
Used in audiograph

MIT license

19KB
412 lines

buffer-pool

Build Status

A Rust "vector of vectors" backed by one contiguous vector. Allows mutable borrows of non-overlapping buffers.

What is BufferPool

BufferPool is a crate that lets you get a slice of a certain size without having to allocate space for a new vector. It does this by pre-allocating a certain region of memory and then handing out references to slices inside this region. It's useful in applications such as audio programming, where allocating and freeing data can be expensive.

Usage

When creating a new BufferPool, it's recommended to use the BufferPoolBuilder interface. While it's completely possible to create a BufferPool yourself, it's less efficient if you know the size of the pool in advance.

let mut pool: BufferPool<usize> = BufferPoolBuilder::new()
    .with_buffer_size(1024)
    .with_capacity(100)
    .build();

let mut buffer = pool.get_cleared_space().unwrap();

for (index, value) in buffer.as_mut().iter_mut().enumerate() {
    *value = index;
}

let sum: usize = buffer.as_ref().iter().sum();

println!("Sum {}", sum);

No runtime deps