Struct MemScopeGuard 

pub struct MemScopeGuard { /* private fields */ }

RAII handle that keeps the auto-export subsystem alive.

Created by start / start_with. Dropping it joins the optional background flusher and then triggers the idempotent exit-path export via lifecycle::export_once. The guard also derefs to GlobalTracker so callers can use track! / track_as / export_html directly on it.

Implementations

impl MemScopeGuard

pub fn tracker(&self) -> &Arc<GlobalTracker>

Borrow the underlying tracker handle.

The returned Arc is the same one registered with the global singleton and the lifecycle hooks, so callers can compare pointers or share it across threads without re-fetching the singleton.

pub fn export_now(&self) -> bool

Trigger an immediate export. Resets the idempotency latch first so a later panic / Ctrl-C / Drop still produces a fresh report.

Returns

true if the export ran; false if no tracker / config is installed (e.g. after reset_for_test).

pub fn snapshot_json(&self) -> MemScopeResult<String>

In-memory JSON snapshot (no disk write). Builds an AnalysisReport via the analyzer pipeline and serializes it. Intended for HTTP endpoints or ad-hoc inspection without touching the filesystem.

Errors

Returns MemScopeError if no tracker is installed (e.g. after reset_global_tracking) or if serialization of the analysis report fails.

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 MemScopeGuard

type Target = GlobalTracker

The resulting type after dereferencing.

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

Dereferences the value.

impl Drop for MemScopeGuard

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.