Struct Trallocator

pub struct Trallocator<A> { /* private fields */ }

A wapper over an allocator that allows tracebility

Implementations

impl<A> Trallocator<A>

pub const fn new(alloc: A) -> Self

Creates a new instance of the traceable allocator using an inner allocator

pub fn usage(&self) -> usize

Get the number of bytes used in the heap

pub fn max_usage(&self) -> usize

Available on crate feature max-usage only.

Get the max usage of the allocator

pub fn clear_max_usage(&self)

Available on crate feature max-usage only.

Clear the max usage and set it to the current usage. Can be used to track max usage per time frame.

pub fn borrow(&self) -> &A

Borrow the inner allocator. Note that using the inner allocator will prevent the allocation to be tracked. Should only be used to init the inner allocator

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

Mutably borrow the inner allocator. Note that using the inner allocator will prevent the allocation to be tracked. Should only be used to init the inner allocator

Trait Implementations

impl<A: Allocator> Allocator for Trallocator<A>

Available on crate feature allocator-api only.

fn allocate(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

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

Attempts to allocate a block of memory.

unsafe fn deallocate(&self, ptr: NonNull<u8>, layout: Layout)

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

Deallocates the memory referenced by ptr.

fn allocate_zeroed(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

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

Behaves like allocate, but also ensures that the returned memory is zero-initialized.

unsafe fn grow( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

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

Attempts to extend the memory block.

unsafe fn grow_zeroed( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

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

Behaves like grow, but also ensures that the new contents are set to zero before being returned.

unsafe fn shrink( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

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

Attempts to shrink the memory block.

fn by_ref(&self) -> &Self

where Self: Sized,

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

Creates a “by reference” adapter for this instance of Allocator.

impl<A: GlobalAlloc> GlobalAlloc for Trallocator<A>

unsafe fn alloc(&self, l: Layout) -> *mut u8

Allocates memory as described by the given layout.

unsafe fn dealloc(&self, ptr: *mut u8, l: Layout)

Deallocates the block of memory at the given ptr pointer with the given layout.

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

Behaves like alloc, but also ensures that the contents are set to zero before being returned.

unsafe fn realloc( &self, ptr: *mut u8, layout: Layout, new_size: usize, ) -> *mut u8

Shrinks or grows a block of memory to the given new_size in bytes. The block is described by the given ptr pointer and layout.