Skip to main content

BufferPool

Struct BufferPool 

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

Page-aligned arena carved into total_chunks fixed-size chunks, handed out and reclaimed via a TreiberStack free-list.

Implementations§

Source§

impl BufferPool

Source

pub fn new(total_chunks: usize, chunk_size: usize) -> Self

Allocate a page-aligned arena of total_chunks chunks of chunk_size bytes each, with all chunks initially free.

§Panics

Panics if total_chunks * chunk_size (each floored to at least 1) overflows or produces a layout with invalid size/alignment for the global allocator (Layout::from_size_align failure), or if the allocator itself fails to satisfy the allocation (handle_alloc_error).

Source

pub const fn get_ptr(&self, idx: u32) -> *mut u8

Raw pointer to the start of chunk idx within the arena. idx must be < total_chunks as passed to Self::new — out-of-range indices produce a pointer outside the arena allocation, which is unsound to dereference (this function itself performs no dereference, only pointer arithmetic).

Source

pub const fn chunk_size(&self) -> usize

The fixed chunk size (in bytes) this pool was constructed with.

Source

pub fn acquire(&self) -> Option<u32>

Borrow a chunk index from the pool; None if exhausted.

Source

pub fn release(&self, idx: u32)

Return a chunk index to the pool.

Trait Implementations§

Source§

impl Drop for BufferPool

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Send for BufferPool

Source§

impl Sync for BufferPool

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> 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, 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.