Struct Profiler 

pub struct Profiler { /* private fields */ }

Available on crate feature dhat-compat only.

RAII handle that writes a DHAT-format JSON report on drop.

Drop-in-shaped replacement for dhat::Profiler. Hold the returned value in main (or wherever you want the file to land) and let scope exit trigger the write.

Example

use mod_alloc::dhat_compat::{Alloc, Profiler};

#[global_allocator]
static ALLOC: Alloc = Alloc;

fn main() {
    let _profiler = Profiler::new_heap();
    let _v: Vec<u8> = vec![0; 1024];
    // _profiler drops here → writes dhat-heap.json
}

Implementations

impl Profiler

pub fn new_heap() -> Self

Construct a heap-mode profiler. Writes dhat-heap.json on drop unless builder().file_name(...) was used.

Examples found in repository

examples/dhat_drop_in.rs (line 36)

fn main() {
    let _profiler = dhat::Profiler::new_heap();

    for _ in 0..500 {
        alloc_small();
    }
    for _ in 0..100 {
        alloc_medium();
    }

    let stats = dhat::HeapStats::get();
    println!(
        "total_blocks: {}, total_bytes: {}, max_bytes: {}, curr_blocks: {}",
        stats.total_blocks, stats.total_bytes, stats.max_bytes, stats.curr_blocks,
    );
    println!("_profiler drops at end of main → writes dhat-heap.json");
}

pub fn new_ad_hoc() -> Self

Construct an ad-hoc-mode profiler. Writes dhat-ad-hoc.json on drop.

pub fn builder() -> ProfilerBuilder

Start a builder for fine-grained configuration.

Trait Implementations

impl Drop for Profiler

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.