Struct byte_arena::Arena

pub struct Arena<const N: usize> { /* private fields */ }

A statically-sized arena for allocation of byte buffers.

Implementations

impl<const N: usize> Arena<N>

pub const fn new(storage: [u8; N]) -> Self

Creates a new Arena.

pub fn alloc(&mut self, size: usize) -> Result<BufMut<'_>, AllocError>

Allocates a new chunk from this Arena.

Returns an AllocError if the given size exceeeds to amount of bytes this Arena can still allocate.

Note that a zero-sized allocation will always suceed and a allocation greater than N will always fail.

pub fn alloc_zeroed(&mut self, size: usize) -> Result<BufMut<'_>, AllocError>

Allocates a new zeroed chunk from this Arena.

This method is equivalent to alloc, except that the returned buffer is zeroed.

pub fn dealloc(&mut self, index: Index)

Deallocates a previously allocated chunk.

pub fn get(&self, index: Index) -> Option<Buf<'_>>

Returns the chunk with the given Index.

pub unsafe fn get_unchecked(&self, index: Index) -> Buf<'_>

Returns the chunk with the given Index without checking if the Index is valid.

Safety

The caller must guarantee:

• The index has been returned from a Buf or BufMut value that has been allocated with this Arena.
• The buffer with the index has not been deallocated.
• No Index values from a different Arena were ever given to get, get_mut, get_unchecked, get_unchecked_mut or dealloc on this Arena instance.

pub fn get_mut(&mut self, index: Index) -> Option<BufMut<'_>>

Returns the chunk with the given Index.

pub unsafe fn get_unchecked_mut(&mut self, index: Index) -> BufMut<'_>

Returns the chunk with the given Index without checking if the Index is valid.

Safety

The caller must guarantee:

• The index has been returned from a Buf or BufMut value that has been allocated with this Arena.
• The buffer with the index has not been deallocated.
• No Index values from a different Arena were ever given to get, get_mut, get_unchecked, get_unchecked_mut or dealloc on this Arena instance.

pub fn clear(&mut self)

Clears all allocations from this Arena.

Trait Implementations

impl<const N: usize> Clone for Arena<N>

fn clone(&self) -> Arena<N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const N: usize> Debug for Arena<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for Arena<N>

fn default() -> Self

Returns the “default value” for a type.