Struct context_allocator::allocators::BumpAllocator

pub struct BumpAllocator<MS: MemorySource> { /* fields omitted */ }

This is a very simple bump allocator of minimal utility.

It:-

• Can efficiently shrink and grow (reallocate) for the most recent allocation made (useful when pushing to a RawVec, say).
• Has no wrapping around at the end (but this could be achieved using a mirror ring buffer).
• Has no ability to resize in place if dead space occurs before next allocation because of alignment.

Is suitable for use with short-lived coroutines, such as those used to make a DNS query.

This allocator NEVER grows or shrinks its memory region.

This allocator is not thread-safe.

Methods

impl<MS: MemorySource> BumpAllocator<MS>

pub fn new(
    memory_source: MS,
    memory_source_size: NonZeroUsize
) -> Result<Self, AllocErr>

New instance wrapping a block of memory.

Trait Implementations

impl<MS: MemorySource> LocalAllocator for BumpAllocator<MS>

fn memory_range(&self) -> MemoryRange

The range of memory addresses that can be used to allocate memory by this allocator.

fn contains(&self, from_memory_address: MemoryAddress) -> bool

Returns true if this allocator is responsible for an allocation starting with the given from_memory_address.

impl<MS: MemorySource> Allocator for BumpAllocator<MS>

fn allocate(
    &self,
    non_zero_size: NonZeroUsize,
    non_zero_power_of_two_alignment: NonZeroUsize
) -> Result<MemoryAddress, AllocErr>

Allocate memory.

fn deallocate(
    &self,
    _non_zero_size: NonZeroUsize,
    _non_zero_power_of_two_alignment: NonZeroUsize,
    current_memory: MemoryAddress
)

Deallocate (free) memory.

fn shrinking_reallocate(
    &self,
    non_zero_new_size: NonZeroUsize,
    _non_zero_power_of_two_alignment: NonZeroUsize,
    _non_zero_current_size: NonZeroUsize,
    current_memory: MemoryAddress
) -> Result<MemoryAddress, AllocErr>

Reallocate memory by shrinking it.

fn growing_reallocate(
    &self,
    non_zero_new_size: NonZeroUsize,
    non_zero_power_of_two_alignment: NonZeroUsize,
    non_zero_current_size: NonZeroUsize,
    current_memory: MemoryAddress
) -> Result<MemoryAddress, AllocErr>

Reallocate memory by growing it.

const ZeroSizedAllocation: MemoryAddress

The sentinel value used for a zero-sized allocation.

fn adapt<'a>(&'a self) -> AllocatorAdaptor<'a, Self>

Adapts to a GlobalAlloc and Alloc.

fn adapt_reference<'a>(&'a self) -> &'a AllocatorAdaptor<'a, Self>

Adapts a reference to a GlobalAlloc and Alloc reference.

impl<MS: MemorySource> Drop for BumpAllocator<MS>

fn drop(&mut self)

Executes the destructor for this type.

impl<MS: Debug + MemorySource> Debug for BumpAllocator<MS>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.