Struct BufferPool

Source

pub struct BufferPool<V: Default + Clone> { /* private fields */ }

Expand description

A “vector of vectors” backed by a single contiguous vector. Allows for mutable borrows of non-overlapping regions.

Implementations§

Source §

pub fn try_clear(&mut self) -> Result<(), ()>

Set all of the values back to their defaults

Source

pub fn clear(&mut self)

Set all of the values back to their defaults

§Panics

If any of the buffers have been borrowed.

Source

pub fn capacity(&self) -> usize

Return the max number of buffers

Source

pub fn change_buffer_size(&mut self, new_buffer_size: usize)

Resize the internal buffers

§Panics

If any of the buffers have been borrowed.

Source

pub fn try_change_buffer_size( &mut self, new_buffer_size: usize, ) -> Result<(), ()>

Resize the internal buffers

Source

pub fn resize_len_and_buffer(&mut self, new_len: usize, new_buffer_size: usize)

Resize both the capacity and buffers

§Panics

If any of the buffers have been borrowed

Source

pub fn is_empty(&self) -> bool

Check whether the buffer pool has no capacity

Source

pub fn reserve(&mut self, additional: usize)

Reserve an additional number of buffers

§Panics

If any of the buffers have been borrowed

Source

pub fn try_reserve(&mut self, additional: usize) -> Result<(), ()>

Reserve an additional number of buffers

Source

pub fn is_borrowed(&self) -> bool

Checks to see whether any of the internal slices have been borrowed.

Source

pub fn resize(&mut self, new_len: usize)

Change the number of internal buffers

§Panics

If any of the internal buffers have been borrowed

Source

pub fn try_resize(&mut self, new_len: usize) -> Result<(), ()>

Change the number of internal buffers

Source

pub fn get_cleared_space(&mut self) -> Result<BufferPoolReference<V>, ()>

Get a reference to a slice of the BufferPool setting the values of the pool back to their default value.

Examples found in repository ?

examples/sum-vector.rs (line 8)

3fn main() {
4    let mut pool: BufferPool<usize> = BufferPoolBuilder::new()
5        .with_buffer_size(1024)
6        .with_capacity(100)
7        .build();
8    let mut buffer = pool.get_cleared_space().unwrap();
9    for (index, value) in buffer.as_mut().iter_mut().enumerate() {
10        *value = index;
11    }
12    let sum: usize = buffer.as_ref().iter().sum();
13    println!("Sum {}", sum);
14}