Struct swim_mem::alloc::Pool

pub struct Pool<'a> { /* fields omitted */ }

Linear allocator for a dynamically growable set of memory blocks.

A Pool allocates space in a sequence of linear memory Packs allocated by a Heap. Pools only reclaim space when the most recent allocation drops, and when the whole pool drops. To free a pool, use IntoHold to move live values to another hold, then drop the pool.

Methods

impl<'a> Pool<'a>

pub fn new(heap: &'a dyn Heap<'a>) -> Pool<'a>

Returns a new Pool that allocates memory from the given heap.

pub fn heap(&self) -> &'a dyn Heap<'a>

Returns the Heap used to allocate memory for the internal pack list.

pub fn size(&self) -> usize

Returns the number of reserved bytes in this Pool.

pub fn live(&self) -> usize

Return the number of live allocations in this Pool.

pub fn used(&self) -> usize

Returns the number of bytes currently allocated in this Pool.

Trait Implementations

impl<'a> Hold<'a> for Pool<'a>

unsafe fn alloc(&self, layout: Layout) -> Result<Block<'a>, HoldError>

Returns an unmanaged pointer to an uninitialized memory block sized and aligned to layout; returns an Err if the allocation fails. The allocated block will have a valid AllocTag in the bytes immediately preceding the block.

unsafe fn dealloc(&self, _block: Block<'a>) -> usize

Releases a memory block allocated by this Hold. Returns the number of freed bytes.

unsafe fn resize(
    &self,
    _block: Block<'a>,
    _layout: Layout
) -> Result<Block<'a>, HoldError>

Attempts to resize in place a memory block allocated by this Hold to fit a new layout. Returns Ok with the resized memory block on success; returns a HoldError on failure.

unsafe fn realloc(
    &self,
    block: Block<'a>,
    layout: Layout
) -> Result<Block<'a>, HoldError>

Attempts to resize a memory block allocated by this Hold to fit a new layout. Returns Ok with the resized memory block on success; returns a HoldError on failure.

impl<'a> Drop for Pool<'a>

fn drop(&mut self)

Executes the destructor for this type.