Struct object_lib::allocators::bump_allocator::BumpAllocator

pub struct BumpAllocator { /* private fields */ }

An std::alloc::Allocator compliant implementation of a bump allocator, currently using an mmap-backed piece of memory as its underlying allocation pool.

The allocator itself is stateless, so that it can be reinstantiated correctly on any machine across object movements. All the data that is needed for correctly instantiating it on a new machine is derived from the underlying storage (currently, the file that is being mmap-ed).

Implementations

impl BumpAllocator

pub fn new(backing_storage: Arc<RwLock<FileHandle>>) -> Self

pub fn can_allocate(&self, allocation_size_bytes: usize) -> bool

pub fn current_write_offset(&self) -> usize

Trait Implementations

impl Allocator for BumpAllocator

fn allocate(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

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

Attempts to allocate a block of memory.

unsafe fn deallocate(&self, _ptr: NonNull<u8>, _layout: Layout)

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

Deallocates the memory referenced by ptr.

fn allocate_zeroed(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

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

Behaves like allocate, but also ensures that the returned memory is zero-initialized.

unsafe fn grow( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout ) -> Result<NonNull<[u8]>, AllocError>

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

Attempts to extend the memory block.

unsafe fn grow_zeroed( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout ) -> Result<NonNull<[u8]>, AllocError>

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

Behaves like grow, but also ensures that the new contents are set to zero before being returned.

unsafe fn shrink( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout ) -> Result<NonNull<[u8]>, AllocError>

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

Attempts to shrink the memory block.

fn by_ref(&self) -> &Selfwhere Self: Sized,

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

Creates a “by reference” adapter for this instance of Allocator.