Struct SlabBox 

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

A smart pointer to an object of type T allocated in a slab.

When this struct goes out of scope, the memory is automatically returned to the originating slab.

Implementations

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

where LOCK: LockTrait,

pub fn new(ptr: NonNull<T>) -> Self

Wraps a raw pointer into a SlabBox.

Safety

• The ptr must be a valid, allocated slot from a Slab with SLAB_SIZE.

pub fn as_ptr(&self) -> *mut T

Returns the raw pointer to the underlying data.

Trait Implementations

impl<T, LOCK, const SLAB_SIZE: usize> Deref for SlabBox<T, LOCK, SLAB_SIZE>

where LOCK: LockTrait,

fn deref(&self) -> &Self::Target

Provides immutable access to the underlying data.

type Target = T

The resulting type after dereferencing.

impl<T, LOCK, const SLAB_SIZE: usize> DerefMut for SlabBox<T, LOCK, SLAB_SIZE>

where LOCK: LockTrait,

fn deref_mut(&mut self) -> &mut Self::Target

Provides mutable access to the underlying data.

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

where LOCK: LockTrait,

fn drop(&mut self)

Automatically returns the memory to the slab 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 SlabBox<T, LOCK, SLAB_SIZE>

where T: Send, LOCK: LockTrait + Sync,

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

where T: Sync, LOCK: LockTrait + Sync,