Struct PprofAlloc 

pub struct PprofAlloc { /* private fields */ }

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

Use this as the process #[global_allocator]. The backing allocator is selected from ALLOCATOR_ENV on first allocation.

Implementations

impl PprofAlloc

pub const fn new() -> Self

Create an allocator with profiling disabled.

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

pub const fn with_default(self, allocator: Allocator) -> Self

Set the allocator used when ALLOCATOR_ENV is unset.

pub const fn with_pprof(self) -> Self

Enable sampled pprof stack profiling using DEFAULT_PPROF_SAMPLE_RATE.

When the active allocator is jemalloc and the backend env selects native profiling, builds with allocator-jemalloc use jemalloc’s native heap profiler instead of wrapper-side allocation tracking.

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. When native jemalloc profiling is selected, this wrapper-side rate is ignored. Use PPROF_SAMPLE_RATE_ENV with configure to set jemalloc’s runtime sample rate.

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. When native jemalloc profiling is selected, configure applies this environment variable to jemalloc’s runtime sample rate.

pub const fn with_stats(self) -> Self

Enable coarse process-wide allocation and free counters.

When the active allocator is jemalloc and jemalloc support is compiled in, snapshots use jemalloc’s native process stats instead of these wrapper-side counters.

Trait Implementations

impl Default for PprofAlloc

fn default() -> Self

Returns the “default value” for a type.

impl GlobalAlloc for PprofAlloc

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.