Struct BufferPool 

pub struct BufferPool { /* private fields */ }

Standard thread-safe buffer pool backed by a Mutex.

Simple and reliable; suitable for most applications. For maximum throughput in high-contention scenarios, prefer crate::pool::FastBufferPool.

Thread Safety

Can be shared across threads via Arc.

Example

use secbuf::prelude::*;

let pool = BufferPool::new(PoolConfig {
    buffer_size: 4096,
    max_pool_size: 100,
    min_pool_size: 10,
});

let mut buf = pool.acquire();
buf.put_u32(42)?;
// Buffer is burned (zeroed) then returned to the pool on drop.

Implementations

impl BufferPool

pub fn new(config: PoolConfig) -> Self

Creates a new buffer pool and pre-warms it with config.min_pool_size buffers.

pub fn acquire(&self) -> PooledBuffer

Acquires a buffer from the pool, allocating a fresh one if the pool is empty.

The returned PooledBuffer is automatically burned and returned (or dropped) when it goes out of scope.

pub fn available(&self) -> usize

Number of buffers currently idle in the pool.

pub fn stats(&self) -> PoolStats

Returns a snapshot of pool statistics.

pub fn shrink(&self)

Truncates idle buffers to min_pool_size, freeing excess memory.

Excess buffers are securely zeroed before being dropped.

pub fn clear(&self)

Removes all idle buffers from the pool.

Buffers are securely zeroed before being dropped (via #[zeroize(drop)]).

pub fn grow(&self, target_size: usize)

Grows the idle pool up to min(target_size, max_pool_size).

Trait Implementations

impl Default for BufferPool

fn default() -> Self

Returns the “default value” for a type.