Skip to main content

Arena

Struct Arena 

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

An epoch-aware arena allocator.

The arena allocates memory in large chunks and uses bump-pointer allocation for fast allocation. Each arena is associated with an epoch, enabling structural sharing for MVCC.

Implementations§

Source§

impl Arena

Source

pub fn new(epoch: EpochId) -> Self

Creates a new arena for the given epoch.

Source

pub fn with_chunk_size(epoch: EpochId, chunk_size: usize) -> Self

Creates a new arena with a custom chunk size.

Source

pub fn epoch(&self) -> EpochId

Returns the epoch this arena belongs to.

Source

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

Allocates size bytes with the given alignment.

§Panics

Panics if allocation fails (out of memory).

Source

pub fn alloc_value<T>(&self, value: T) -> &mut T

Allocates a value of type T.

Source

pub fn alloc_slice<T: Copy>(&self, values: &[T]) -> &mut [T]

Allocates a slice of values.

Source

pub fn total_allocated(&self) -> usize

Returns the total memory allocated by this arena.

Source

pub fn total_used(&self) -> usize

Returns the total memory used (not just allocated capacity).

Source

pub fn stats(&self) -> ArenaStats

Returns statistics about this arena.

Auto Trait Implementations§

§

impl !Freeze for Arena

§

impl !RefUnwindSafe for Arena

§

impl Send for Arena

§

impl Sync for Arena

§

impl Unpin for Arena

§

impl UnwindSafe for Arena

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.