TreiberSlab

Struct TreiberSlab 

Source
pub struct TreiberSlab { /* private fields */ }
Expand description

A lock-free slab allocator backed by a region.

This is a convenience wrapper around TreiberSlabRaw that manages memory through a Region. All operations delegate to the raw implementation.

Implementations§

Source§

impl TreiberSlab

Source

pub unsafe fn init( region: Region, header_offset: usize, slot_count: u32, slot_size: u32, ) -> Self

Initialize a new slab at header_offset in the region.

§Safety

The region must be writable and exclusively owned during initialization.

Source

pub unsafe fn attach( region: Region, header_offset: usize, ) -> Result<Self, &'static str>

Attach to an existing slab.

§Safety

The region must contain a valid, initialized slab header at header_offset.

Source

pub fn inner(&self) -> &TreiberSlabRaw

Get a reference to the inner raw slab.

Source

pub fn try_alloc(&self) -> AllocResult

Try to allocate a slot.

Delegates to TreiberSlabRaw::try_alloc.

Source

pub fn mark_in_flight(&self, handle: SlotHandle) -> Result<(), SlotError>

Mark a slot as in-flight (after enqueue).

Delegates to TreiberSlabRaw::mark_in_flight.

Source

pub fn free(&self, handle: SlotHandle) -> Result<(), SlotError>

Free an in-flight slot and push it to the free list.

Delegates to TreiberSlabRaw::free.

Source

pub fn free_allocated(&self, handle: SlotHandle) -> Result<(), SlotError>

Free a slot that is still Allocated (never sent).

Delegates to TreiberSlabRaw::free_allocated.

Source

pub unsafe fn slot_data_ptr(&self, handle: SlotHandle) -> *mut u8

Return a pointer to the slot data.

§Safety

The handle must be valid and the slot must be allocated.

Source

pub fn slot_size(&self) -> u32

Returns the slot size in bytes.

Source

pub fn slot_count(&self) -> u32

Returns the total number of slots.

Source

pub fn free_count_approx(&self) -> u32

Approximate number of free slots.

Trait Implementations§

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more