Struct dhat::Profiler

pub struct Profiler;

A type whose lifetime dictates the start and end of profiling.

Profiling starts when the first value of this type is created. Profiling stops when (a) this value is dropped or (b) a dhat assertion fails, whichever comes first. When that happens, profiling data may be written to file, depending on how the Profiler has been configured. Only one Profiler can be running at any point in time.

Implementations

impl Profiler

pub fn new_heap() -> Self

Initiates allocation profiling.

Typically the first thing in main. Its result should be assigned to a variable whose lifetime ends at the end of main.

Panics

Panics if another Profiler is running.

Examples

let _profiler = dhat::Profiler::new_heap();

pub fn new_ad_hoc() -> Self

Initiates ad hoc profiling.

Typically the first thing in main. Its result should be assigned to a variable whose lifetime ends at the end of main.

Panics

Panics if another Profiler is running.

Examples

let _profiler = dhat::Profiler::new_ad_hoc();

pub fn builder() -> ProfilerBuilder

Creates a new ProfilerBuilder, which defaults to heap profiling.

Trait Implementations

impl Debug for Profiler

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Profiler

fn drop(&mut self)

Executes the destructor for this type.