Struct PprofAlloc 

pub struct PprofAlloc<A = System> { /* private fields */ }

Global allocator wrapper that can collect allocation counters and pprof heap profiles.

Use this as a #[global_allocator] around std::alloc::System or another allocator implementing GlobalAlloc. Profiling and coarse allocation counters are opt-in through the builder methods.

Implementations

impl PprofAlloc<System>

pub const fn new() -> Self

Create a wrapper around std::alloc::System with profiling disabled.

Use Self::with_pprof, Self::with_pprof_sample_rate, or Self::with_stats to enable collection.

impl<A> PprofAlloc<A>

pub const fn from_allocator(inner: A) -> Self

Create a wrapper around a custom allocator with profiling disabled.

pub const fn with_pprof(self) -> Self

Enable sampled pprof stack profiling using DEFAULT_PPROF_SAMPLE_RATE.

pub const fn with_pprof_sample_rate(self, bytes: usize) -> Self

Enable sampled pprof stack profiling with an explicit byte sample rate.

A rate of 1 records every allocation. A rate of 0 disables pprof stack recording while still allowing other enabled collectors to run.

pub const fn with_pprof_sample_rate_from_env(self, default_rate: usize) -> Self

Enable pprof stack profiling with the sample rate read from the environment.

PPROF_SAMPLE_RATE_ENV is read lazily on the first profiled allocation. If the variable is missing or invalid, default_rate is used.

pub const fn with_stats(self) -> Self

Enable coarse process-wide allocation and free counters.

Trait Implementations

impl Default for PprofAlloc<System>

fn default() -> Self

Returns the “default value” for a type.

impl<A: GlobalAlloc> GlobalAlloc for PprofAlloc<A>

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

Allocates memory as described by 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 dealloc(&self, ptr: *mut u8, layout: Layout)

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

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.