Struct AutoExportConfig 

pub struct AutoExportConfig {
    pub output_path: PathBuf,
    pub formats: ExportFormatSet,
    pub on_exit: bool,
    pub on_panic: bool,
    pub on_signal: SignalPolicy,
    pub flush_interval: Option<Duration>,
    pub exit_timeout: Duration,
}

Configuration for the automatic export subsystem.

Controls WHERE reports are written, WHICH formats, and WHICH exit paths trigger an export. All fields have sensible defaults via Default, so a plain AutoExportConfig::default() yields a working “export HTML+JSON to ./memscope-report on any exit” setup.

Fields

output_path: PathBuf

Directory to write reports into. Created if missing. Default: ./memscope-report.

formats: ExportFormatSet

Which output formats to produce. Default: HTML + JSON.

on_exit: bool

Export on normal program return (Drop guard fires). Default: true.

on_panic: bool

Export on panic (panic-hook chaining). Critical for panic = "abort" release builds. Default: true.

on_signal: SignalPolicy

Which signals trigger an export. Default: CtrlC.

flush_interval: Option<Duration>

If Some(interval), spawn a background worker that flushes every interval. If None, no background flushing (export only on exit). Default: None.

exit_timeout: Duration

Max time the shutdown path waits for an in-flight export to finish before giving up. Default: 5s.

Implementations

impl AutoExportConfig

pub fn with_output_path(self, path: impl Into<PathBuf>) -> Self

Builder-style: set output path.

pub fn with_formats(self, formats: ExportFormatSet) -> Self

Builder-style: set formats.

pub fn with_flush_interval(self, interval: Duration) -> Self

Builder-style: enable periodic flushing.

pub fn with_signal_policy(self, policy: SignalPolicy) -> Self

Builder-style: set signal policy.

pub fn with_on_exit(self, on_exit: bool) -> Self

Builder-style: set the on_exit flag (export on normal Drop).

pub fn with_on_panic(self, on_panic: bool) -> Self

Builder-style: set the on_panic flag (export on panic).

pub fn with_exit_timeout(self, timeout: Duration) -> Self

Builder-style: set the shutdown timeout for in-flight exports.

pub fn is_auto_export_enabled(&self) -> bool

True if any export path is enabled (exit, panic, or signal != Off).

pub fn wants_html(&self) -> bool

True if the HTML format is selected.

pub fn wants_json(&self) -> bool

True if the JSON format is selected.

Trait Implementations

impl Clone for AutoExportConfig

fn clone(&self) -> AutoExportConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AutoExportConfig

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

Formats the value using the given formatter.

impl Default for AutoExportConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AutoExportConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AutoExportConfig

fn eq(&self, other: &AutoExportConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AutoExportConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AutoExportConfig