Skip to main content

BufferPool

Struct BufferPool 

Source
pub struct BufferPool { /* private fields */ }
Expand description

A lock-free pool of pre-allocated receive buffers.

BufferPool avoids heap allocation in the hot path by recycling bytes::BytesMut buffers via a bounded, lock-free queue.

When the pool is exhausted, BufferPool::get falls back to allocating a new zeroed buffer — the pool never blocks.

§Example

use binger_udp::BufferPool;

let pool = BufferPool::new(16, 2048);
let mut buf = pool.get();
buf.extend_from_slice(b"hello");
pool.put(buf);
assert_eq!(pool.available(), 1);

Implementations§

Source§

impl BufferPool

Source

pub fn new(capacity: usize, buf_size: usize) -> Self

Creates a new buffer pool with capacity buffers, each of buf_size bytes.

Buffers are lazily allocated — the constructor itself does not allocate.

Source

pub fn get(&self) -> BytesMut

Retrieves a buffer from the pool, or allocates a new zeroed one if the pool is empty.

Returned buffers are cleared before being handed out.

Source

pub fn put(&self, buf: BytesMut)

Returns a buffer to the pool for reuse.

If the pool is full the buffer is silently dropped (the pool never grows).

Source

pub fn available(&self) -> usize

Number of buffers currently available in the pool.

Source

pub fn capacity(&self) -> usize

Maximum number of buffers the pool can hold.

Trait Implementations§

Source§

impl Clone for BufferPool

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.