Struct Allocator 

pub struct Allocator { /* private fields */ }

Implementations

impl Allocator

pub unsafe fn create( file: &File, file_size: usize, min_workers: u32, slab_size: u32, ) -> Result<Self, Error>

Create a new Allocator in the provided file with the given parameters. min_workers is the minimum number of workers to support.

Safety

• create must only be called once for a given file. Subsequent calls with the same file must use join.

pub fn join(file: &File) -> Result<Self, Error>

Join an existing allocator in the provided file. Picks the first available worker slot.

Note

Prefer Self::join_from_existing to re-use mmaps within the same process.

pub fn join_from_existing(existing: &Allocator) -> Result<Self, Error>

Join an existing allocator using the same in-process mapping. Picks the first available worker slot.

pub fn join_from_existing_free_only( existing: &FreeOnlyAllocator, ) -> Result<Self, Error>

Join an existing free-only allocator using the same in-process mapping. Picks the first available worker slot.

impl Allocator

pub fn allocate(&self, size: u32) -> Option<NonNull<u8>>

Allocates a block of memory of the given size. If the size is larger than the maximum size class, returns None. If the allocation fails, returns None.

impl Allocator

pub unsafe fn free(&self, ptr: NonNull<u8>)

Free a block of memory previously allocated by this allocator.

Safety

• The ptr must be a valid pointer to a block of memory allocated by this allocator.
• The ptr must not have been freed before.

pub unsafe fn free_offset(&self, offset: usize)

Free a block of memory previously allocated by this allocator.

Safety

• The offset must be a valid offset to a block of memory allocated by this allocator, i.e. an offset returned by Self::offset.
• The offset must not have been freed before.

pub unsafe fn offset(&self, ptr: NonNull<u8>) -> usize

Find the offset given a pointer.

Safety

• The ptr must be a valid pointer in the allocator’s address space.

pub unsafe fn ptr_from_offset(&self, offset: usize) -> NonNull<u8>

Return a ptr given a shareable offset - calculated by offset.

Safety

• Caller must ensure the offset is valid for this allocator.

impl Allocator

pub fn outstanding_allocation_bytes(&self) -> u64

pub fn clean_remote_frees(&self)

Frees all remotely freed items queued for this worker.

impl Allocator

pub fn remote_free_batch(&self) -> RemoteFreeBatch<'_>

Create a batch that groups remote frees by owning worker.

Locally owned allocations are reclaimed immediately. Remote frees are published by RemoteFreeBatch::flush or when the batch is dropped.

Trait Implementations

impl Drop for Allocator

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for Allocator