Skip to main content

ArenaAllocator

Struct ArenaAllocator 

Source
pub struct ArenaAllocator { /* private fields */ }
Expand description

The global arena allocator managing multiple epochs.

Implementations§

Source§

impl ArenaAllocator

Source

pub fn new() -> Self

Creates a new arena allocator.

Source

pub fn with_chunk_size(chunk_size: usize) -> Self

Creates a new arena allocator with a custom chunk size.

Source

pub fn current_epoch(&self) -> EpochId

Returns the current epoch.

Source

pub fn new_epoch(&self) -> EpochId

Creates a new epoch and returns its ID.

Source

pub fn arena(&self, epoch: EpochId) -> impl Deref<Target = Arena> + '_

Gets the arena for a specific epoch.

§Panics

Panics if the epoch doesn’t exist.

Source

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

Allocates in the current epoch.

Source

pub fn drop_epoch(&self, epoch: EpochId)

Drops an epoch, freeing all its memory.

This should only be called when no readers are using this epoch.

Source

pub fn total_allocated(&self) -> usize

Returns total memory allocated across all epochs.

Trait Implementations§

Source§

impl Default for ArenaAllocator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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.