Struct Bump 

pub struct Bump { /* private fields */ }

A thread-safe bump allocator that provides Sync + Send semantics.

Each thread gets its own BumpLocal instance.

Implementations

impl Bump

pub fn new() -> Self

Creates a new Bump allocator.

pub fn builder() -> BumpBuilder

Returns a BumpBuilder for configuring a Bump allocator.

Examples

use bump_local::Bump;

let bump = Bump::builder()
    .threads_capacity(8)
    .bump_capacity(4096)
    .build();

pub fn local(&self) -> &BumpLocal

Returns the BumpLocal for the current thread, or creates it if it doesn’t exist.

If reset_all was called earlier, this would reset the current thread’s allocator which is O(1).

pub fn reset_all(&mut self) -> Result<(), ResetError>

Resets all threads’ bump allocators, deallocating all previously allocated memory.

Safety Contract

• At the moment of reset it must be the only handle to the Bump.
• Like bumpalo::Bump::reset(), callers must ensure no references to allocated memory are used after calling this method.
• This does not run any Drop implementations.

Trait Implementations

impl Allocator for Bump

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.

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.

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.

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.

fn by_ref(&self) -> &Self

where Self: Sized,

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

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

impl Clone for Bump

fn clone(&self) -> Bump

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Bump

fn default() -> Bump

Returns the “default value” for a type.