Struct arcon_allocator::Allocator

pub struct Allocator { /* fields omitted */ }

An Allocator for arcon.

The allocator is not meant to handle all heap allocations during the execution. However, it is intended to be used to manage memory for different sections of the runtime. This includes message buffers, network buffers, and state indexes.

Implementations

impl Allocator

pub fn new(limit: usize) -> Allocator

Creates a new Allocator with the given memory limit size

pub unsafe fn alloc<T>(&mut self, capacity: usize) -> AllocResult

Allocate memory block of type T with given capacity

Safety

It is up to the caller to ensure dealloc with the generated AllocId

pub unsafe fn dealloc(&mut self, id: AllocId)

Deallocate memory through the given AllocId

Safety

It is up to the caller to ensure that the given AllocId is active

pub fn allocated_bytes(&self) -> usize

Returns amount of bytes that are currently allocated

pub fn total_allocations(&self) -> u128

Returns total allocations made so far

pub fn bytes_remaining(&self) -> usize

Returns how much bytes are available to allocate

Trait Implementations

impl Debug for Allocator

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

Formats the value using the given formatter.

impl Drop for Allocator

pub fn drop(&mut self)

Executes the destructor for this type.

impl Send for Allocator