Struct xalloc::tlsf::Tlsf

pub struct Tlsf<T, A, P>where
    A: UnsafeArena<TlsfBlock<T, P>, Ptr = P>,
    P: Clone + Default + PartialEq + Eq + Debug,{ /* private fields */ }

TLSF-based external memory allocator.

See the module-level documentation for more.

Type parameters

• T is an integer type used to represent region sizes. You usually use u32 or u64 for this.
• A is a memory arena type used to allocate internal block structures.

Implementations

impl<T: BinaryUInteger> Tlsf<T, CheckedArena<TlsfBlock<T, Ptr>>, Ptr>

pub fn new(size: T) -> Self

Construct a SafeTlsf.

impl<T: BinaryUInteger> Tlsf<T, PooledArena<TlsfBlock<T, Ptr>, SysAllocator, Ptr>, Ptr>

pub fn new(size: T) -> Self

Construct a SysTlsf.

pub fn with_capacity(size: T, capacity: usize) -> Self

Construct a SysTlsf with a specific capacity.

impl<T, P, A> Tlsf<T, A, P>where
    T: BinaryUInteger,
    A: UnsafeArena<TlsfBlock<T, P>, Ptr = P>,
    P: Clone + Default + PartialEq + Eq + Debug,

pub fn with_arena(size: T, arena: A) -> Self

Construct a Tlsf.

pub fn arena(&self) -> &A

Get a reference to the underlying memory arena.

pub fn arena_mut(&mut self) -> &mut A

Get a mutable reference to the underlying memory arena.

pub fn alloc_aligned(&mut self, size: T, align: T) -> Option<(TlsfRegion<P>, T)>

Allocate a region of the size size with a given alignment requirement.

Returns a handle of the allocated region and its offset if the allocation succeeds. Returns None otherwise.

• align must be a power of two.
• size must not be zero.

pub fn alloc(&mut self, size: T) -> Option<(TlsfRegion<P>, T)>

Allocate a region of the size size.

Returns a handle of the allocated region and its offset if the allocation succeeds. Returns None otherwise.

size must not be zero.

pub unsafe fn dealloc_unchecked(&mut self, r: TlsfRegion<P>)

Deallocate the specified region, without checking the origin of the TlsfRegion.

This might result in an undefined behavior if r originates from a different instance of Tlsf.

impl<T, P, A> Tlsf<T, A, P>where
    T: BinaryUInteger,
    A: UnsafeArena<TlsfBlock<T, P>, Ptr = P> + UnsafeArenaWithMembershipCheck<TlsfBlock<T, P>>,
    P: Clone + Default + PartialEq + Eq + Debug,

pub fn dealloc(&mut self, r: TlsfRegion<P>) -> Result<(), TlsfRegion<P>>

Deallocate the specified region.

Returns Err(r) if r does not originate from the same instance of Tlsf.

impl<T, P, A> Tlsf<T, A, P>where
    T: BinaryUInteger,
    A: UnsafeArena<TlsfBlock<T, P>, Ptr = P> + SafeArena<TlsfBlock<T, P>>,
    P: Clone + Default + PartialEq + Eq + Debug,

pub fn dealloc_relaxed(&mut self, r: TlsfRegion<P>)

Deallocate the specified region.

r must originate from the same instance of Tlsf. Otherwise, Tlsf enters an inconsistent state and possibly panics, but does not cause an undefined behavior.

Trait Implementations

impl<T: Debug, A: Debug, P: Debug> Debug for Tlsf<T, A, P>where
    A: UnsafeArena<TlsfBlock<T, P>, Ptr = P>,
    P: Clone + Default + PartialEq + Eq + Debug,

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

Formats the value using the given formatter.