Struct symbolic_debuginfo::breakpad::BreakpadObject

pub struct BreakpadObject<'d> { /* fields omitted */ }

A Breakpad object file.

To process minidump crash reports without having to understand all sorts of native symbol formats, the Breakpad processor uses a text-based symbol file format. It comprises records describing the object file, functions and lines, public symbols, as well as unwind information for stackwalking.

The platform-specific symbol dumping tools parse the debugging information the compiler provides (whether as DWARF or STABS sections in an ELF file or as stand-alone PDB files), and write that information back out in the Breakpad symbol file format. This format is much simpler and less detailed than compiler debugging information, and values legibility over compactness.

The full documentation resides here.

Methods

impl<'d> BreakpadObject<'d>

pub fn test(data: &[u8]) -> bool

Tests whether the buffer could contain a Breakpad object.

pub fn parse(data: &'d [u8]) -> Result<Self, BreakpadError>

Tries to parse a Breakpad object from the given slice.

pub fn file_format(&self) -> FileFormat

The container file format, which is always FileFormat::Breakpad.

pub fn code_id(&self) -> Option<CodeId>

The code identifier of this object.

pub fn debug_id(&self) -> DebugId

The debug information identifier of this object.

pub fn arch(&self) -> Arch

The CPU architecture of this object.

pub fn name(&self) -> &'d str

The debug file name of this object.

This is the name of the original debug file that was used to create the Breakpad file. On Windows, this will have a .pdb extension, on other platforms that name is likely equivalent to the name of the code file (shared library or executable).

pub fn kind(&self) -> ObjectKind

The kind of this object.

pub fn load_address(&self) -> u64

The address at which the image prefers to be loaded into memory.

When Breakpad symbols are written, all addresses are rebased relative to the load address. Since the original load address is not stored in the file, it is assumed as zero.

pub fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

Important traits for BreakpadSymbolIterator<'d>

impl<'d> Iterator for BreakpadSymbolIterator<'d> type Item = Symbol<'d>;

pub fn symbols(&self) -> BreakpadSymbolIterator<'d>

Returns an iterator over symbols in the public symbol table.

pub fn symbol_map(&self) -> SymbolMap<'d>

Returns an ordered map of symbols in the symbol table.

pub fn has_debug_info(&self) -> bool

Determines whether this object contains debug information.

pub fn debug_session(&self) -> Result<BreakpadDebugSession<'d>, BreakpadError>

Constructs a debugging session.

A debugging session loads certain information from the object file and creates caches for efficient access to various records in the debug information. Since this can be quite a costly process, try to reuse the debugging session as long as possible.

Constructing this session will also work if the object does not contain debugging information, in which case the session will be a no-op. This can be checked via has_debug_info.

pub fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

Important traits for BreakpadInfoRecords<'d>

impl<'d> Iterator for BreakpadInfoRecords<'d> type Item = Result<BreakpadInfoRecord<'d>, BreakpadError>;

pub fn info_records(&self) -> BreakpadInfoRecords<'d>

Returns an iterator over info records.

Important traits for BreakpadFileRecords<'d>

impl<'d> Iterator for BreakpadFileRecords<'d> type Item = Result<BreakpadFileRecord<'d>, BreakpadError>;

pub fn file_records(&self) -> BreakpadFileRecords<'d>

Returns an iterator over file records.

pub fn file_map(&self) -> BreakpadFileMap<'d>

Returns a map for file name lookups by id.

Important traits for BreakpadPublicRecords<'d>

impl<'d> Iterator for BreakpadPublicRecords<'d> type Item = Result<BreakpadPublicRecord<'d>, BreakpadError>;

pub fn public_records(&self) -> BreakpadPublicRecords<'d>

Returns an iterator over public symbol records.

Important traits for BreakpadFuncRecords<'d>

impl<'d> Iterator for BreakpadFuncRecords<'d> type Item = Result<BreakpadFuncRecord<'d>, BreakpadError>;

pub fn func_records(&self) -> BreakpadFuncRecords<'d>

Returns an iterator over function records.

Important traits for BreakpadStackRecords<'d>

impl<'d> Iterator for BreakpadStackRecords<'d> type Item = Result<BreakpadStackRecord<'d>, BreakpadError>;

pub fn stack_records(&self) -> BreakpadStackRecords<'d>

Returns an iterator over stack frame records.

pub fn data(&self) -> &'d [u8]

Returns the raw data of the Breakpad file.

Trait Implementations

impl<'d> ObjectLike for BreakpadObject<'d>

type Error = BreakpadError

Errors thrown when reading information from this object.

type Session = BreakpadDebugSession<'d>

A session that allows optimized access to debugging information.

fn file_format(&self) -> FileFormat

The container format of this file.

fn code_id(&self) -> Option<CodeId>

The code identifier of this object.

fn debug_id(&self) -> DebugId

The debug information identifier of this object.

fn arch(&self) -> Arch

The CPU architecture of this object.

fn kind(&self) -> ObjectKind

The kind of this object.

fn load_address(&self) -> u64

The address at which the image prefers to be loaded into memory.

fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

fn symbols(&self) -> DynIterator<Symbol>

Returns an iterator over symbols in the public symbol table.

fn symbol_map(&self) -> SymbolMap

Returns an ordered map of symbols in the symbol table.

fn has_debug_info(&self) -> bool

Determines whether this object contains debug information.

fn debug_session(&self) -> Result<Self::Session, Self::Error>

Constructs a debugging session.

fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

fn debug_file_name(&self) -> Option<Cow<str>>

The filename of the debug companion file.

impl<'_> Debug for BreakpadObject<'_>

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

Formats the value using the given formatter.

impl<'slf, 'd: 'slf> AsSelf<'slf> for BreakpadObject<'d>

type Ref = BreakpadObject<'slf>

The Self type with 'slf lifetimes, returned by as_self.

fn as_self(&'slf self) -> &Self::Ref

Returns a reference to self with downcasted lifetime.