[−][src]Struct symbolic_debuginfo::breakpad::BreakpadObject
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.
Implementations
impl<'d> BreakpadObject<'d>
[src]
pub fn test(data: &[u8]) -> bool
[src]
Tests whether the buffer could contain a Breakpad object.
pub fn parse(data: &'d [u8]) -> Result<Self, BreakpadError>
[src]
Tries to parse a Breakpad object from the given slice.
pub fn file_format(&self) -> FileFormat
[src]
The container file format, which is always FileFormat::Breakpad
.
pub fn code_id(&self) -> Option<CodeId>
[src]
The code identifier of this object.
pub fn debug_id(&self) -> DebugId
[src]
The debug information identifier of this object.
pub fn arch(&self) -> Arch
[src]
The CPU architecture of this object.
pub fn name(&self) -> &'d str
[src]
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
[src]
The kind of this object.
pub fn load_address(&self) -> u64
[src]
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
[src]
Determines whether this object exposes a public symbol table.
pub fn symbols(&self) -> BreakpadSymbolIterator<'d>ⓘNotable traits for BreakpadSymbolIterator<'d>
impl<'d> Iterator for BreakpadSymbolIterator<'d> type Item = Symbol<'d>;
[src]
Notable traits for BreakpadSymbolIterator<'d>
impl<'d> Iterator for BreakpadSymbolIterator<'d> type Item = Symbol<'d>;
Returns an iterator over symbols in the public symbol table.
pub fn symbol_map(&self) -> SymbolMap<'d>
[src]
Returns an ordered map of symbols in the symbol table.
pub fn has_debug_info(&self) -> bool
[src]
Determines whether this object contains debug information.
pub fn debug_session(&self) -> Result<BreakpadDebugSession<'d>, BreakpadError>
[src]
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
[src]
Determines whether this object contains stack unwinding information.
pub fn has_sources(&self) -> bool
[src]
Determines whether this object contains embedded source.
pub fn info_records(&self) -> BreakpadInfoRecords<'d>ⓘNotable traits for BreakpadInfoRecords<'d>
impl<'d> Iterator for BreakpadInfoRecords<'d> type Item = Result<BreakpadInfoRecord<'d>, BreakpadError>;
[src]
Notable traits for BreakpadInfoRecords<'d>
impl<'d> Iterator for BreakpadInfoRecords<'d> type Item = Result<BreakpadInfoRecord<'d>, BreakpadError>;
Returns an iterator over info records.
pub fn file_records(&self) -> BreakpadFileRecords<'d>ⓘNotable traits for BreakpadFileRecords<'d>
impl<'d> Iterator for BreakpadFileRecords<'d> type Item = Result<BreakpadFileRecord<'d>, BreakpadError>;
[src]
Notable traits for BreakpadFileRecords<'d>
impl<'d> Iterator for BreakpadFileRecords<'d> type Item = Result<BreakpadFileRecord<'d>, BreakpadError>;
Returns an iterator over file records.
pub fn file_map(&self) -> BreakpadFileMap<'d>
[src]
Returns a map for file name lookups by id.
pub fn public_records(&self) -> BreakpadPublicRecords<'d>ⓘNotable traits for BreakpadPublicRecords<'d>
impl<'d> Iterator for BreakpadPublicRecords<'d> type Item = Result<BreakpadPublicRecord<'d>, BreakpadError>;
[src]
Notable traits for BreakpadPublicRecords<'d>
impl<'d> Iterator for BreakpadPublicRecords<'d> type Item = Result<BreakpadPublicRecord<'d>, BreakpadError>;
Returns an iterator over public symbol records.
pub fn func_records(&self) -> BreakpadFuncRecords<'d>ⓘNotable traits for BreakpadFuncRecords<'d>
impl<'d> Iterator for BreakpadFuncRecords<'d> type Item = Result<BreakpadFuncRecord<'d>, BreakpadError>;
[src]
Notable traits for BreakpadFuncRecords<'d>
impl<'d> Iterator for BreakpadFuncRecords<'d> type Item = Result<BreakpadFuncRecord<'d>, BreakpadError>;
Returns an iterator over function records.
pub fn stack_records(&self) -> BreakpadStackRecords<'d>ⓘNotable traits for BreakpadStackRecords<'d>
impl<'d> Iterator for BreakpadStackRecords<'d> type Item = Result<BreakpadStackRecord<'d>, BreakpadError>;
[src]
Notable traits for BreakpadStackRecords<'d>
impl<'d> Iterator for BreakpadStackRecords<'d> type Item = Result<BreakpadStackRecord<'d>, BreakpadError>;
Returns an iterator over stack frame records.
pub fn data(&self) -> &'d [u8]
[src]
Returns the raw data of the Breakpad file.
Trait Implementations
impl<'slf, 'd: 'slf> AsSelf<'slf> for BreakpadObject<'d>
[src]
type Ref = BreakpadObject<'slf>
The Self
type with 'slf
lifetimes, returned by as_self
.
fn as_self(&'slf self) -> &Self::Ref
[src]
impl<'_> Debug for BreakpadObject<'_>
[src]
impl<'d> ObjectLike for BreakpadObject<'d>
[src]
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
[src]
fn code_id(&self) -> Option<CodeId>
[src]
fn debug_id(&self) -> DebugId
[src]
fn arch(&self) -> Arch
[src]
fn kind(&self) -> ObjectKind
[src]
fn load_address(&self) -> u64
[src]
fn has_symbols(&self) -> bool
[src]
fn symbols(&self) -> DynIterator<'_, Symbol<'_>>
[src]
fn symbol_map(&self) -> SymbolMap<'_>
[src]
fn has_debug_info(&self) -> bool
[src]
fn debug_session(&self) -> Result<Self::Session, Self::Error>
[src]
fn has_unwind_info(&self) -> bool
[src]
fn has_sources(&self) -> bool
[src]
Auto Trait Implementations
impl<'d> RefUnwindSafe for BreakpadObject<'d>
impl<'d> Send for BreakpadObject<'d>
impl<'d> Sync for BreakpadObject<'d>
impl<'d> Unpin for BreakpadObject<'d>
impl<'d> UnwindSafe for BreakpadObject<'d>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,