Struct SlabCache 

pub struct SlabCache<T, LOCK, const SLAB_SIZE: usize>
where
    LOCK: LockTrait,
{ /* private fields */ }

A thread-safe, reference-counted handle to a Master-Slave slab hierarchy.

SlabCache allows you to allocate fixed-size objects of type T with $O(1)$ complexity. It manages the expansion of memory by adding Slave slabs when needed.

Implementations

impl<T, LOCK, const SLAB_SIZE: usize> SlabCache<T, LOCK, SLAB_SIZE>

where LOCK: LockTrait,

pub fn new() -> Result<SlabCache<T, LOCK, SLAB_SIZE>>

Creates a new SlabCache and initializes the Master Slab.

This will trigger an initial system allocation for the first Master segment.

Errors

• SlabError::OutOfMemory: If the initial system allocation fails.

Example

let mut cache = SlabCache::<MyStruct, SpinLock, 4096>::new()?;
let my_obj = cache.alloc()?;

pub fn alloc(&mut self) -> Result<SlabBox<T, LOCK, SLAB_SIZE>>

Allocates a new object of type T from the cache.

The returned SlabBox acts like a Box<T>, automatically returning the memory to the slab when it goes out of scope.

If the current Master and its Slaves are full, this method will automatically allocate a new Slave slab and link it to the hierarchy.

Errors

• SlabError::OutOfMemory: If no space is available and a new Slave cannot be created.
• SlabError::FatalError: If the cache’s master pointer is null.

Trait Implementations

impl<T, LOCK, const SLAB_SIZE: usize> Clone for SlabCache<T, LOCK, SLAB_SIZE>

where LOCK: LockTrait,

fn clone(&self) -> Self

Creates a new handle to the same Master slab.

This increments the internal reference count of the Master slab, ensuring it remains valid even if the original SlabCache is dropped.

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

Performs copy-assignment from source.

impl<T, LOCK, const SLAB_SIZE: usize> Drop for SlabCache<T, LOCK, SLAB_SIZE>

where LOCK: LockTrait,

fn drop(&mut self)

Drops the handle and potentially cleans up the allocator.

Decrements the Master’s reference count. If this was the last handle and the Master has no active Slaves or used slots, the memory is returned to the system.

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<T, LOCK, const SLAB_SIZE: usize> Send for SlabCache<T, LOCK, SLAB_SIZE>

where T: Send, LOCK: LockTrait + Sync,

impl<T, LOCK, const SLAB_SIZE: usize> Sync for SlabCache<T, LOCK, SLAB_SIZE>

where T: Send, LOCK: LockTrait + Sync,