19 releases (8 breaking)

new 0.15.0 Nov 30, 2022
0.13.0 Jul 26, 2022
0.10.2 Mar 24, 2022
0.9.6 Dec 8, 2021
0.1.0 Dec 21, 2017

#55 in Parser implementations

Download history 687/week @ 2022-08-10 545/week @ 2022-08-17 527/week @ 2022-08-24 487/week @ 2022-08-31 436/week @ 2022-09-07 542/week @ 2022-09-14 710/week @ 2022-09-21 408/week @ 2022-09-28 374/week @ 2022-10-05 380/week @ 2022-10-12 553/week @ 2022-10-19 884/week @ 2022-10-26 786/week @ 2022-11-02 550/week @ 2022-11-09 657/week @ 2022-11-16 501/week @ 2022-11-23

2,570 downloads per month
Used in 7 crates (6 directly)

MIT license

735KB
15K SLoC

minidump

crates.io

Basic parsing of the minidump format.

If you want richer analysis of the minidump (such as stackwalking and symbolication), use minidump-processor.

Usage

The primary API for this library is the Minidump struct, which can be instantiated by calling the Minidump::read or Minidump::read_path methods.

Succesfully parsing a Minidump struct means the minidump has a minimally valid header and stream directory. Individual streams are only parsed when they're requested.

Although you may enumerate the streams in a minidump with methods like Minidump::all_streams, this is only really useful for debugging. Instead you should statically request streams with Minidump::get_stream.

Depending on what analysis you're trying to perform, you may:

  • Consider it an error for a stream to be missing (using ? or unwrap)
  • Branch on the presence of stream to conditionally refine your analysis
  • Use a stream's Default implementation to get an "empty" instance (with unwrap_or_default)
use minidump::*;

fn main() -> Result<(), Error> {
    // Read the minidump from a file
    let mut dump = minidump::Minidump::read_path("../testdata/test.dmp")?;

    // Statically request (and require) several streams we care about:
    let system_info = dump.get_stream::<MinidumpSystemInfo>()?;
    let exception = dump.get_stream::<MinidumpException>()?;

    // Combine the contents of the streams to perform more refined analysis
    let crash_reason = exception.get_crash_reason(system_info.os, system_info.cpu);

    // Conditionally analyze a stream
    if let Ok(threads) = dump.get_stream::<MinidumpThreadList>() {
        // Use `Default` to try to make progress when a stream is missing.
        // This is especially natural for MinidumpMemoryList because
        // everything needs to handle memory lookups failing anyway.
        let mem = dump.get_stream::<MinidumpMemoryList>().unwrap_or_default();

        for thread in &threads.threads {
            let stack = thread.stack_memory(&mem);
            // ...
        }
    }
    Ok(())
}

Dependencies

~4.5MB
~73K SLoC