Struct allocator_suite::memory_sources::arena_memory_source::arena_memory_source::ArenaMemorySource

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

An arena memory source.

Methods

impl<MS: MemorySource> ArenaMemorySource<MS>

pub fn new_by_amount(
    memory_source: MS,
    block_size: NonZeroUsize,
    memory_source_size: NonZeroUsize,
    block_initializer: impl Fn(MemoryAddress, NonZeroUsize)
) -> Result<Self, AllocErr>

Create a new instance by memory size and block size.

pub fn new(
    memory_source: MS,
    block_size: NonZeroUsize,
    number_of_blocks: NonZeroUsize,
    block_initializer: impl Fn(MemoryAddress, NonZeroUsize)
) -> Result<Self, AllocErr>

Creates a new instance.

block_size must be at least 8 to be useful. block_initializer takes the address of a block and the size of a block; after it is called, the block will have the first 8 bytes (4 bytes on 32-bit platforms) overwritten with a slot index pointer.

Trait Implementations

impl<MS: MemorySource> MemorySource for ArenaMemorySource<MS>

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

Obtain memory from the operating system, say.

fn release(&self, non_zero_size: NonZeroUsize, current_memory: MemoryAddress)

Release memory to the operating system, say.

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

fn drop(&mut self)

Executes the destructor for this type.

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

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

Formats the value using the given formatter.