Struct BufferPool 

pub struct BufferPool { /* private fields */ }

Self-tuning buffer pool for efficient memory reuse

The pool automatically adjusts buffer sizes based on observed usage patterns via the PoolCalibrator. Buffers are reused to reduce allocation overhead.

Example

use stoolap::common::BufferPool;

let pool = BufferPool::new(4096, 1024 * 1024, "test");

// Get a buffer from the pool
let mut buf = pool.get();
buf.extend_from_slice(b"hello world");

// Return the buffer to the pool for reuse
pool.put(buf);

Implementations

impl BufferPool

pub fn new(default_size: usize, max_size: usize, name: &str) -> Self

Create a new buffer pool

Arguments

• default_size - Initial size for allocated buffers
• max_size - Maximum buffer size (buffers larger than this are discarded)
• name - Name of the pool (for debugging/logging)

pub fn with_pool_size( default_size: usize, max_size: usize, name: &str, pool_size: usize, ) -> Self

Create a new buffer pool with specified pool size

pub fn get(&self) -> Vec<u8>

Get a buffer from the pool

Returns a buffer from the pool if available, otherwise creates a new one. The buffer is cleared before returning.

pub fn get_with_capacity(&self, capacity: usize) -> Vec<u8>

Get a buffer with at least the specified capacity

pub fn put(&self, buf: Vec<u8>)

Return a buffer to the pool

The buffer is cleared and returned to the pool for reuse. Buffers larger than max_size are discarded to prevent memory bloat.

pub fn record_size(&self, size: usize)

Record a buffer size for calibration

This is called automatically during put(), but can also be called manually to record sizes without returning a buffer.

pub fn get_optimal_size(&self) -> usize

Get the current optimal size based on calibration

pub fn default_size(&self) -> usize

Get the current default buffer size

pub fn max_size(&self) -> usize

Get the maximum allowed buffer size

pub fn name(&self) -> &str

Get the pool name

pub fn available(&self) -> usize

Get the number of buffers currently in the pool

pub fn stats(&self) -> PoolStats

Get statistics about the pool

Trait Implementations

impl Debug for BufferPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BufferPool

fn default() -> Self

Returns the “default value” for a type.