Skip to main content

BumpAllocator

Struct BumpAllocator 

Source
pub struct BumpAllocator<P: MemoryPool> { /* private fields */ }
Expand description

Bump allocator for sequential allocations

Simple and fast allocator that only supports allocation, not deallocation of individual items. Perfect for temporary buffers and stack-like usage.

Implementations§

Source§

impl<P: MemoryPool> BumpAllocator<P>

Source

pub const fn new(pool: P) -> Self

Create a new bump allocator with the given pool

Source

pub fn allocate(&self, size: usize, align: usize) -> Result<NonNull<u8>>

Allocate memory from the bump allocator

§Errors

Returns error if the pool is exhausted or alignment requirements cannot be met

Source

pub fn capacity(&self) -> usize

Get the total capacity

Source

pub fn used(&self) -> usize

Get currently used bytes

Source

pub fn available(&self) -> usize

Get available bytes

Source

pub unsafe fn reset(&self) -> Result<()>

Reset the allocator (reclaim all memory)

§Safety

All pointers allocated from this allocator must not be used after reset

Trait Implementations§

Source§

impl<P: MemoryPool + Sync> GlobalAlloc for BumpAllocator<P>

Available on crate feature alloc only.
Source§

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocates memory as described by the given layout. Read more
Source§

unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout)

Deallocates the block of memory at the given ptr pointer with the given layout. Read more
1.28.0 · Source§

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

Behaves like alloc, but also ensures that the contents are set to zero before being returned. Read more
1.28.0 · Source§

unsafe fn realloc( &self, ptr: *mut u8, layout: Layout, new_size: usize, ) -> *mut u8

Shrinks or grows a block of memory to the given new_size in bytes. The block is described by the given ptr pointer and layout. Read more

Auto Trait Implementations§

§

impl<P> Freeze for BumpAllocator<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for BumpAllocator<P>
where P: RefUnwindSafe,

§

impl<P> Send for BumpAllocator<P>
where P: Send,

§

impl<P> Sync for BumpAllocator<P>
where P: Sync,

§

impl<P> Unpin for BumpAllocator<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for BumpAllocator<P>
where P: UnsafeUnpin,

§

impl<P> UnwindSafe for BumpAllocator<P>
where P: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.