Struct bufferpool::BufferPool

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

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

Methods

impl<V: Default + Clone> BufferPool<V>

pub fn builder() -> BufferPoolBuilder<V>

pub fn get_buffer_size(&self) -> usize

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

Set all of the values back to their defaults

pub fn clear(&mut self)

Set all of the values back to their defaults

Panics

If any of the buffers have been borrowed.

pub fn capacity(&self) -> usize

Return the max number of buffers

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

Resize the internal buffers

Panics

If any of the buffers have been borrowed.

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

Resize the internal buffers

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

pub fn is_empty(&self) -> bool

Check whether the buffer pool has no capacity

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

Reserve an additional number of buffers

Panics

If any of the buffers have been borrowed

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

Reserve an additional number of buffers

pub fn is_borrowed(&self) -> bool

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

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

Change the number of internal buffers

Panics

If any of the internal buffers have been borrowed

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

Change the number of internal buffers

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.

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

Get a reference to a slice of the BufferPool.

Trait Implementations

impl<V: Default + Clone> Default for BufferPool<V>

fn default() -> BufferPool<V>

Returns the "default value" for a type.