Struct MemoryProfiler 

pub struct MemoryProfiler { /* private fields */ }

Simple memory profiler that tracks peak RSS usage over its lifetime.

Designed to be shared via Arc<MemoryProfiler> across threads. All mutable state is stored in atomics, so no locking is required.

Example

use oxibonsai_runtime::memory::MemoryProfiler;

let profiler = MemoryProfiler::new();

// Sample at some point during processing
let snap = profiler.sample();
println!("current RSS: {} bytes", snap.rss_bytes);

// Peak may differ from current if memory was freed
println!("peak RSS:    {} bytes", profiler.peak_rss_bytes());
println!("delta:       {} bytes", profiler.delta_bytes());

Implementations

impl MemoryProfiler

pub fn new() -> Self

Create a new profiler, recording the current RSS as the baseline.

pub fn sample(&self) -> MemorySnapshot

Take a memory snapshot, updating the peak if necessary.

Lock-free and safe to call from any thread.

pub fn peak_rss_bytes(&self) -> u64

Highest RSS observed across all sample() calls and at creation.

pub fn start_rss_bytes(&self) -> u64

RSS at the time this profiler was created.

pub fn delta_bytes(&self) -> i64

Signed difference: peak_rss − start_rss.

Positive means memory grew; negative (rare) means the OS reclaimed pages between profiler creation and the peak sample.

pub fn sample_count(&self) -> u64

Total number of sample() calls made on this profiler.

pub fn take_snapshot(&self) -> MemorySnapshot

Take a memory snapshot, updating the peak if necessary.

Alias for sample using the name required by the task specification.

pub fn current_rss_bytes(&self) -> Option<u64>

Current RSS in bytes as Option<u64>.

Returns None on platforms where RSS reading is unsupported (WASM, etc.). On Linux and macOS this always returns Some(value), where value may be 0 only in the extremely unlikely case that the OS returns an error.

Trait Implementations

impl Debug for MemoryProfiler

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

Formats the value using the given formatter.

impl Default for MemoryProfiler

fn default() -> Self

Returns the “default value” for a type.