Struct MemCtx 

pub struct MemCtx { /* private fields */ }

Convenience session handle — one-call init, track!-able, one-call export.

Examples

use memscope_rs::prelude::*;

let ctx = MemCtx::init()?;
let data = vec![1u64; 100];
track!(ctx, data);       // macro auto-derefs to GlobalTracker
ctx.export("./report")?; // delegate to GlobalTracker::export_html

Implementations

impl MemCtx

pub fn init() -> MemScopeResult<Self>

Initialise logging + global tracking in one call.

pub fn start() -> MemScopeResult<MemScopeGuard>

One-line start with the default configuration.

Equivalent to MemCtx::start_with(MemScopeConfig::default()). The returned MemScopeGuard triggers the exit-path export (HTML + JSON to ./memscope-report) on drop, covering normal return, panic, and — when the auto-signal feature is enabled — Ctrl-C.

This is the recommended entry point for new code. Existing code that calls MemCtx::init + MemCtx::export continues to work unchanged.

Errors

Returns MemScopeError if logging init, global tracker init, or lifecycle hook installation fails.

pub fn start_with(config: MemScopeConfig) -> MemScopeResult<MemScopeGuard>

One-line start with a custom MemScopeConfig.

Like MemCtx::start but accepts a user-supplied configuration for output path, formats, signal policy, and periodic flush interval. The returned MemScopeGuard owns the optional background flusher and triggers the exit-path export on drop.

Errors

Returns MemScopeError if any of the setup steps fails. A repeated call without reset_global_tracking fails at the global-tracker init step.

pub fn export(&self, path: impl AsRef<Path>) -> MemScopeResult<()>

Export complete dashboard (HTML + JSON) under path.

Methods from Deref<Target = GlobalTracker>

pub fn tracker(&self) -> &Tracker

pub fn passport_tracker(&self) -> &Arc<MemoryPassportTracker>

pub fn async_tracker(&self) -> &Arc<AsyncTracker>

pub fn elapsed(&self) -> Duration

pub fn track<T: Trackable>(&self, var: &T)

pub fn track_as<T: Trackable>( &self, var: &T, name: &str, file: &str, line: u32, module_path: &str, )

pub fn create_passport( &self, ptr: usize, size: usize, context: String, ) -> Result<String, TrackingError>

pub fn record_handover(&self, ptr: usize, context: String, function: String)

pub fn record_free(&self, ptr: usize, context: String, function: String)

pub fn detect_leaks(&self) -> LeakDetectionResult

pub fn analyze(&self) -> AnalysisReport

pub fn get_stats(&self) -> GlobalTrackerStats

pub fn export_json<P: AsRef<Path>>(&self, path: P) -> MemScopeResult<()>

pub fn export_html<P: AsRef<Path>>(&self, path: P) -> MemScopeResult<()>

pub fn export_html_with_template<P: AsRef<Path>>( &self, path: P, template: DashboardTemplate, ) -> MemScopeResult<()>

Trait Implementations

impl Deref for MemCtx

type Target = GlobalTracker

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.