Skip to main content

BufferPool

Struct BufferPool 

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

A pool of reusable GPU-style byte buffers.

Callers acquire a buffer via acquire (receiving its ID), read/write via get_mut, then return it to the pool with release.

Implementations§

Source§

impl BufferPool

Source

pub fn new(max_pool_bytes: usize) -> Self

Create a new pool that will hold at most max_pool_bytes of backing storage before refusing new allocations.

Source

pub fn acquire(&mut self, size_bytes: usize, alignment: usize) -> Option<u64>

Check out a buffer of at least size_bytes with at least alignment.

Strategy: find the smallest existing compatible free buffer to minimise fragmentation. If none exists, allocate a new one (provided the pool is below its byte budget).

Returns the buffer id on success, or None if no buffer is available and allocating a new one would exceed the pool’s byte budget.

Source

pub fn release(&mut self, id: u64) -> bool

Return a buffer to the pool by id.

The buffer is kept for future reuse but marked as available. Returns true if the buffer was found and released, false otherwise.

Source

pub fn get(&self, id: u64) -> Option<&GpuBuffer>

Borrow the buffer with the given id.

Source

pub fn get_mut(&mut self, id: u64) -> Option<&mut GpuBuffer>

Mutably borrow the buffer with the given id.

Source

pub fn defragment(&mut self)

Evict all free buffers that have not been used for more than 60 seconds.

In-use buffers are never evicted.

Source

pub fn stats(&self) -> PoolStats

Snapshot of pool metrics.

Source

pub fn total_allocated_bytes(&self) -> usize

Total bytes currently under management.

Source

pub fn max_pool_bytes(&self) -> usize

Maximum pool capacity in bytes.

Trait Implementations§

Source§

impl Debug for BufferPool

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,