Skip to main content

BytesPool

Struct BytesPool 

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

Tiered buffer pool for zero-copy buffer management.

This pool provides 4 tiers of buffers for different size ranges:

  • Small: 4KB - 64KB
  • Medium: 64KB - 512KB
  • Large: 512KB - 4MB
  • XLarge: > 4MB

Buffers are automatically reused when returned to the pool.

§Example

ⓘ
let pool = BytesPool::new_tiered();

// Acquire a buffer (automatically selects tier based on size)
let mut buffer = pool.acquire_buffer(8192).await;

// Use the buffer...
buffer.put_slice(b"hello world");

// Return to pool (automatic when dropped)
drop(buffer);

// Next acquisition will reuse the buffer
let mut buffer2 = pool.acquire_buffer(8192).await;
assert!(pool.hit_rate() > 0.0); // Buffer was reused!

Implementations§

Source§

impl BytesPool

Source

pub fn new_tiered() -> Self

Create new tiered pool with default configuration.

§Tier Configuration
  • Small: 4KB buffers, max 1000 concurrent
  • Medium: 64KB buffers, max 500 concurrent
  • Large: 512KB buffers, max 100 concurrent
  • XLarge: 4MB buffers, max 25 concurrent
§Example
ⓘ
let pool = BytesPool::new_tiered();
Source

pub fn with_config(config: BytesPoolConfig) -> Self

Create pool with custom configuration.

§Example
ⓘ
let config = BytesPoolConfig {
    small_size: 8 * 1024,  // 8KB small buffers
    small_max: 2000,
    ..Default::default()
};
let pool = BytesPool::with_config(config);
Source

pub async fn acquire_buffer(&self, size: usize) -> PooledBuffer

Acquire buffer with automatic tier selection.

Selects the appropriate tier based on requested size and blocks until a buffer is available. Reuses returned buffers when available.

§Arguments
  • size - Minimum capacity for the buffer
§Returns

A PooledBuffer that releases the permit and returns buffer to pool when dropped.

§Example
ⓘ
let mut buffer = pool.acquire_buffer(8192).await;
Source

pub fn try_acquire_buffer(&self, size: usize) -> Option<PooledBuffer>

Try to acquire buffer without blocking.

§Arguments
  • size - Minimum capacity for the buffer
§Returns
  • Some(buffer) - If a buffer was available
  • None - If the pool is at capacity
§Example
ⓘ
if let Some(mut buffer) = pool.try_acquire_buffer(8192) {
    // Use buffer...
}
Source

pub fn metrics(&self) -> &BytesPoolMetrics

Get pool metrics.

Source

pub fn hit_rate(&self) -> f64

Get pool hit rate (0.0 - 1.0).

Source

pub fn available_buffers(&self) -> u64

Get the number of available buffers in the pool.

Trait Implementations§

Source§

impl Clone for BytesPool

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
Source§

impl Debug for BytesPool

Source§

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

Formats the value using the given formatter. 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more