Struct bulk_allocator::BulkAllocator

pub struct BulkAllocator<'a, B: 'a + AllocRef> { /* fields omitted */ }

BulkAllocator pools allocated memory and frees it on the destruction.

alloc() delegates the request to the backend if the requested layout is too large to cache; otherwise, it dispatches the pooled memory and return. If no memory is pooled, acquire memory chunk from the backend.

dealloc() delegates the request to the backend if the requested layout is too large to cache; otherwise, it pools the passed memory.

If the argument layout of alloc() is always same, probably LayoutBulkAllocator is better than BulkAllocator.

Lifetime

Each instance owns or borrows the backend AllocRef instance. If it is borrowed, the lifetime is limited by the reference; otherwise, the lifetime will be 'static.

Thread safety

All the mutable methods are thread unsafe.

Warnings

After drop, programer must NOT use the memories which method alloc() of this instance returned.

Trait Implementations

impl<'_, B: AllocRef> AllocRef for BulkAllocator<'_, B>

Thread safety

All the methods are thread unsafe.

fn alloc(
    &mut self,
    layout: Layout,
    init: AllocInit
) -> Result<MemoryBlock, AllocErr>

🔬 This is a nightly-only experimental API. (allocator_api)

Attempts to allocate a block of memory.

unsafe fn dealloc(&mut self, ptr: NonNull<u8>, layout: Layout)

🔬 This is a nightly-only experimental API. (allocator_api)

Deallocates the memory referenced by ptr.

unsafe fn grow(
    &mut self,
    ptr: NonNull<u8>,
    layout: Layout,
    new_size: usize,
    placement: ReallocPlacement,
    init: AllocInit
) -> Result<MemoryBlock, AllocErr>

🔬 This is a nightly-only experimental API. (allocator_api)

Attempts to extend the memory block.

unsafe fn shrink(
    &mut self,
    ptr: NonNull<u8>,
    layout: Layout,
    new_size: usize,
    placement: ReallocPlacement
) -> Result<MemoryBlock, AllocErr>

🔬 This is a nightly-only experimental API. (allocator_api)

Attempts to shrink the memory block.

fn by_ref(&mut self) -> &mut Self

🔬 This is a nightly-only experimental API. (allocator_api)

Creates a "by reference" adaptor for this instance of AllocRef.

impl<B> Default for BulkAllocator<'static, B> where
    B: AllocRef + Default, 

fn default() -> Self

The backend is constructed by Default::default() and the new instance owns it.

impl<'_, B: AllocRef> Drop for BulkAllocator<'_, B>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, B> From<&'a mut B> for BulkAllocator<'a, B> where
    B: 'a + AllocRef, 

fn from(backend: &'a mut B) -> Self

The new instance borrows the backend and the lifetime is limited by it.

impl<B: AllocRef> From<B> for BulkAllocator<'static, B>

fn from(backend: B) -> Self

The new instance owns the backend.