Struct PeakMemorySampler 

pub struct PeakMemorySampler { /* private fields */ }

Tracks the peak resident set size (RSS) of the current process across a profiling run.

Engines call sample at chunk/batch boundaries and sample_now once at the end; the peak observed feeds ExecutionMetadata::memory_peak_mb. The reading is the whole-process RSS, so on embedded surfaces (e.g. the Python extension) it includes host-process memory — it is an upper bound on what profiling used, suitable for verifying the bounded-memory claim, not an exact attribution.

Implementations

impl PeakMemorySampler

pub fn new() -> Self

Create a sampler and take an initial reading.

pub fn sample(&mut self)

Sample unless the previous sample is less than [MIN_SAMPLE_INTERVAL] old. For per-chunk calls inside a loop.

pub fn sample_now(&mut self)

Refresh the process RSS and fold it into the running peak, whatever the interval. For the final reading of a run, so the reported peak covers the work done after the last throttled sample.

pub fn peak_mb(&self) -> Option<f64>

Peak RSS observed so far, in megabytes.

None when the platform provided no reading — callers should leave memory_peak_mb absent (not analyzed) rather than report zero.

Trait Implementations

impl Default for PeakMemorySampler

fn default() -> Self

Returns the “default value” for a type.