Struct tracy_client::ProfiledAllocator

pub struct ProfiledAllocator<T>(_, _);

A profiling wrapper around another allocator.

See documentation for std::alloc for more information about global allocators.

Note that this wrapper will start up the client on the first allocation, if not enabled already.

Examples

In your executable, add:

#[global_allocator]
static GLOBAL: ProfiledAllocator<std::alloc::System> =
    ProfiledAllocator::new(std::alloc::System, 100);

Implementations

impl<T> ProfiledAllocator<T>

pub const fn new(inner_allocator: T, callstack_depth: u16) -> Self

Construct a new ProfiledAllocator.

Specifying a non-zero callstack_depth will enable collection of callstack for this message. The number provided will limit the number of call frames collected. Note that enabling callstack collection introduces a non-trivial amount of overhead to each allocation and deallocation.

Trait Implementations

impl<T: GlobalAlloc> GlobalAlloc for ProfiledAllocator<T>

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

Allocate memory as described by the given layout.

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

Deallocate 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

Shrink or grow a block of memory to the given new_size. The block is described by the given ptr pointer and layout.