ScratchPool

Struct ScratchPool 

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

A named scratch pool for cross-frame temporary allocations.

Scratch pools are useful for memory that:

  • Lives longer than a frame
  • But is still scratch-like (bulk freed)
  • Is associated with a subsystem or task

Implementations§

Source§

impl ScratchPool

Source

pub fn new(name: &'static str, capacity: usize) -> Self

Create a new scratch pool.

Source

pub fn name(&self) -> &'static str

Get the pool name.

Source

pub fn alloc<T>(&mut self) -> *mut T

Allocate memory from this pool.

Source

pub fn alloc_layout(&mut self, layout: Layout) -> *mut u8

Allocate with a specific layout.

Source

pub fn alloc_slice<T>(&mut self, count: usize) -> *mut T

Allocate a slice.

Source

pub fn reset(&mut self)

Reset the pool, invalidating all allocations.

Source

pub fn allocated(&self) -> usize

Get bytes allocated.

Source

pub fn remaining(&self) -> usize

Get remaining capacity.

Source

pub fn capacity(&self) -> usize

Get total capacity.

Trait Implementations§

Source§

impl Drop for ScratchPool

Source§

fn drop(&mut self)

Executes the destructor for this type. 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> 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.