Skip to main content

enable_heap_profiling_with

Function enable_heap_profiling_with 

Source
pub fn enable_heap_profiling_with(config: &ProfConfig) -> bool
Expand description

Turn on sampled heap profiling using a struct-based configuration.

Sibling of enable_heap_profiling for callers that need more than a single sample rate – e.g. seeding the sampler, capping profiler-arena memory, or registering an exit-time dump path/format. See ProfConfig and, for the full FALLBACK/OVERRIDE semantics, mi_prof_config_mode_t in include/mimalloc/profile.h.

Returns false if profiling was already enabled (the earlier session stays active), or if config.dump_at_exit is set but is not representable as a NUL-free C string (non-UTF-8 or an embedded NUL byte) – in that case mi_prof_start_ex is never called.