Struct Arena

pub struct Arena { /* private fields */ }

A bump allocation arena.

Examples

let mut arena = Arena::new(1000);


let mut buffers = Vec::new();
for _ in 0..10 {
    // All 10 buffers will be allocated in the same chunk.
    let mut buf = arena.alloc(100);

    buffers.push(buf);
}

// The buffers may outlive the arena they were allocated with.
drop(arena);

buffers[0][0] = 1;

Implementations

impl Arena

pub fn new(chunk_size: usize) -> Self

Creates a new Arena using the given chunk_size for every allocated chunk.

Panics

Panics if chunk_size is bigger than isize::MAX.

pub fn alloc(&self, size: usize) -> BytesMut

Allocates a new BytesMut from the Arena.

Note that the returned BytesMut may contain previously used buffers. If you need to create a zeroed BytesMut, consider using zeroed.

pub fn zeroed(&self, size: usize) -> BytesMut

Allocates a new, zeroed BytesMut from the Arena.

Note that zeroed zeroes the returned BytesMut. If that’s not necessary you may want to use alloc, which does not zero the returned BytesMut.

Trait Implementations

impl Debug for Arena

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

Formats the value using the given formatter.

impl Default for Arena

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Arena

fn drop(&mut self)

Executes the destructor for this type.