Struct boxing_arena::BoxingArena

pub struct BoxingArena<T> { /* fields omitted */ }

The BoxingArena struct.

Methods

impl<T> BoxingArena<T>

pub fn new() -> Self

Create a new BoxingArena. All memory used by empty boxes will be de-allocated when the BoxingArena is dropped. No allocation is made by this function.

pub fn with_capacity(size: usize) -> Self

Create a new BoxingArena with the given capacity of free boxes.

pub fn unbox(&mut self, v: Box<T>) -> T

This function unboxes the value but keeps the allocation for later reuse by the rebox function.

pub fn rebox(&mut self, v: T) -> Box<T>

When boxing a value, the arena either allocates a new Box or uses an existing empty allocation from a previous 'unbox` operation. In the latter case, allocation would be very fast, and the overhead would be mostly the move into the box.

pub fn try_rebox(&mut self, v: &mut Option<T>) -> Option<Box<T>>

Like rebox but only if there are empty boxes. Return None if *v is None. The stack overhead of this function is guaranteed in the order of pointer-sized.

pub fn capacity(&self) -> usize

Return the number of free boxes in the BoxingArena.

pub fn resize_capacity(&mut self, size: usize)

Resize boxes pool to a given capacity.

pub fn trim(&mut self, size: usize)

Trims capacity to the given size if it is larger.

Trait Implementations

impl<T> Drop for BoxingArena<T>

fn drop(&mut self)

Executes the destructor for this type.