Struct Bump

pub struct Bump<A: BackingAllocator> { /* private fields */ }

A bump allocator.

For a general discussion of bump allocation, see the module-level documentation.

Implementations

impl Bump<Raw>

pub unsafe fn new_raw( region: NonNull<u8>, layout: Layout, ) -> Result<Bump<Raw>, AllocInitError>

Constructs a new Bump from a raw pointer.

Safety

The caller must uphold the following invariants:

• region must be a pointer to a region that fits layout, and it must be valid for reads and writes for the entire size indicated by layout.
• No references to the memory at region may exist when this function is called.
• As long as the returned Bump exists, no accesses may be made to the memory at region except by way of methods on the returned Bump.

impl Bump<Global>

pub fn try_new(layout: Layout) -> Result<Bump<Global>, AllocInitError>

Available on crate feature alloc only.

Attempts to construct a new Bump backed by the global allocator.

The memory managed by this Bump is allocated from the global allocator according to layout.

Errors

Returns an error if sufficient memory could not be allocated from the global allocator.

impl<A> Bump<A>

where A: Allocator,

pub fn try_new_in( layout: Layout, backing_allocator: A, ) -> Result<Bump<A>, AllocInitError>

Available on crate feature unstable only.

Attempts to construct a new Bump backed by backing_allocator.

The memory managed by this Bump is allocated from backing_allocator according to layout.

Errors

Returns an error if sufficient memory could not be allocated from backing_allocator.

impl<A> Bump<A>

where A: BackingAllocator,

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

Attempts to allocate a block of memory according to layout.

Errors

Returns Err if there is insufficient memory remaining to accommodate layout.

pub unsafe fn deallocate(&mut self, ptr: NonNull<u8>)

Deallocates a block of memory.

This operation does not increase the amount of available memory unless ptr is the last outstanding allocation from this allocator.

Safety

ptr must denote a block of memory currently allocated via this allocator.

pub unsafe fn reset(&mut self)

Resets the bump allocator.

This method invalidates all outstanding allocations from this allocator. The destructors of allocated objects will not be run.

Safety

The caller must uphold the following invariants:

• No references to memory allocated by this Bump may exist when the method is called.
• Any pointers to memory previously allocated by this allocator may no longer be dereferenced or passed to Bump::deallocate().

Trait Implementations

impl<A> Debug for Bump<A>

where A: BackingAllocator,

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

Formats the value using the given formatter.

impl<A> Drop for Bump<A>

where A: BackingAllocator,

fn drop(&mut self)

Executes the destructor for this type.