pub struct BreakpadObject<'data> { /* private fields */ }
Expand description
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
sourceimpl<'data> BreakpadObject<'data>
impl<'data> BreakpadObject<'data>
sourcepub fn parse(data: &'data [u8]) -> Result<BreakpadObject<'data>, BreakpadError>
pub fn parse(data: &'data [u8]) -> Result<BreakpadObject<'data>, BreakpadError>
Tries to parse a Breakpad object from the given slice.
sourcepub fn file_format(&self) -> FileFormat
pub fn file_format(&self) -> FileFormat
The container file format, which is always FileFormat::Breakpad
.
sourcepub fn name(&self) -> &'data str
pub fn name(&self) -> &'data 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).
sourcepub fn kind(&self) -> ObjectKind
pub fn kind(&self) -> ObjectKind
The kind of this object.
sourcepub fn load_address(&self) -> u64
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.
sourcepub fn has_symbols(&self) -> bool
pub fn has_symbols(&self) -> bool
Determines whether this object exposes a public symbol table.
sourcepub fn symbols(&self) -> BreakpadSymbolIterator<'data>ⓘNotable traits for BreakpadSymbolIterator<'data>impl<'data> Iterator for BreakpadSymbolIterator<'data> type Item = Symbol<'data>;
pub fn symbols(&self) -> BreakpadSymbolIterator<'data>ⓘNotable traits for BreakpadSymbolIterator<'data>impl<'data> Iterator for BreakpadSymbolIterator<'data> type Item = Symbol<'data>;
Returns an iterator over symbols in the public symbol table.
sourcepub fn symbol_map(&self) -> SymbolMap<'data>
pub fn symbol_map(&self) -> SymbolMap<'data>
Returns an ordered map of symbols in the symbol table.
sourcepub fn has_debug_info(&self) -> bool
pub fn has_debug_info(&self) -> bool
Determines whether this object contains debug information.
sourcepub fn debug_session(
&self
) -> Result<BreakpadDebugSession<'data>, BreakpadError>
pub fn debug_session(
&self
) -> Result<BreakpadDebugSession<'data>, 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
.
sourcepub fn has_unwind_info(&self) -> bool
pub fn has_unwind_info(&self) -> bool
Determines whether this object contains stack unwinding information.
sourcepub fn has_sources(&self) -> bool
pub fn has_sources(&self) -> bool
Determines whether this object contains embedded source.
sourcepub fn is_malformed(&self) -> bool
pub fn is_malformed(&self) -> bool
Determines whether this object is malformed and was only partially parsed
sourcepub fn info_records(&self) -> BreakpadInfoRecords<'data>ⓘNotable traits for BreakpadInfoRecords<'d>impl<'d> Iterator for BreakpadInfoRecords<'d> type Item = Result<BreakpadInfoRecord<'d>, BreakpadError>;
pub fn info_records(&self) -> BreakpadInfoRecords<'data>ⓘNotable traits for BreakpadInfoRecords<'d>impl<'d> Iterator for BreakpadInfoRecords<'d> type Item = Result<BreakpadInfoRecord<'d>, BreakpadError>;
Returns an iterator over info records.
sourcepub fn file_records(&self) -> BreakpadFileRecords<'data>ⓘNotable traits for BreakpadFileRecords<'d>impl<'d> Iterator for BreakpadFileRecords<'d> type Item = Result<BreakpadFileRecord<'d>, BreakpadError>;
pub fn file_records(&self) -> BreakpadFileRecords<'data>ⓘNotable traits for BreakpadFileRecords<'d>impl<'d> Iterator for BreakpadFileRecords<'d> type Item = Result<BreakpadFileRecord<'d>, BreakpadError>;
Returns an iterator over file records.
sourcepub fn file_map(&self) -> BTreeMap<u64, &'data str, Global>
pub fn file_map(&self) -> BTreeMap<u64, &'data str, Global>
Returns a map for file name lookups by id.
sourcepub fn public_records(&self) -> BreakpadPublicRecords<'data>ⓘNotable traits for BreakpadPublicRecords<'d>impl<'d> Iterator for BreakpadPublicRecords<'d> type Item = Result<BreakpadPublicRecord<'d>, BreakpadError>;
pub fn public_records(&self) -> BreakpadPublicRecords<'data>ⓘNotable traits for BreakpadPublicRecords<'d>impl<'d> Iterator for BreakpadPublicRecords<'d> type Item = Result<BreakpadPublicRecord<'d>, BreakpadError>;
Returns an iterator over public symbol records.
sourcepub fn func_records(&self) -> BreakpadFuncRecords<'data>ⓘNotable traits for BreakpadFuncRecords<'d>impl<'d> Iterator for BreakpadFuncRecords<'d> type Item = Result<BreakpadFuncRecord<'d>, BreakpadError>;
pub fn func_records(&self) -> BreakpadFuncRecords<'data>ⓘNotable traits for BreakpadFuncRecords<'d>impl<'d> Iterator for BreakpadFuncRecords<'d> type Item = Result<BreakpadFuncRecord<'d>, BreakpadError>;
Returns an iterator over function records.
sourcepub fn stack_records(&self) -> BreakpadStackRecords<'data>ⓘNotable traits for BreakpadStackRecords<'d>impl<'d> Iterator for BreakpadStackRecords<'d> type Item = Result<BreakpadStackRecord<'d>, BreakpadError>;
pub fn stack_records(&self) -> BreakpadStackRecords<'data>ⓘNotable traits for BreakpadStackRecords<'d>impl<'d> Iterator for BreakpadStackRecords<'d> type Item = Result<BreakpadStackRecord<'d>, BreakpadError>;
Returns an iterator over stack frame records.
Trait Implementations
sourceimpl<'slf, 'data> AsSelf<'slf> for BreakpadObject<'data> where
'data: 'slf,
impl<'slf, 'data> AsSelf<'slf> for BreakpadObject<'data> where
'data: 'slf,
type Ref = BreakpadObject<'slf>
type Ref = BreakpadObject<'slf>
The Self
type with 'slf
lifetimes, returned by as_self
.
sourcefn as_self(&'slf self) -> &'slf <BreakpadObject<'data> as AsSelf<'slf>>::Ref
fn as_self(&'slf self) -> &'slf <BreakpadObject<'data> as AsSelf<'slf>>::Ref
Returns a reference to self
with downcasted lifetime.
sourceimpl<'_> Debug for BreakpadObject<'_>
impl<'_> Debug for BreakpadObject<'_>
sourceimpl<'data, 'object> ObjectLike<'data, 'object> for BreakpadObject<'data> where
'data: 'object,
impl<'data, 'object> ObjectLike<'data, 'object> for BreakpadObject<'data> where
'data: 'object,
type Error = BreakpadError
type Error = BreakpadError
Errors thrown when reading information from this object.
type Session = BreakpadDebugSession<'data>
type Session = BreakpadDebugSession<'data>
A session that allows optimized access to debugging information.
type SymbolIterator = BreakpadSymbolIterator<'data>
type SymbolIterator = BreakpadSymbolIterator<'data>
The iterator over the symbols in the public symbol table.
sourcefn file_format(&self) -> FileFormat
fn file_format(&self) -> FileFormat
The container format of this file.
sourcefn kind(&self) -> ObjectKind
fn kind(&self) -> ObjectKind
The kind of this object.
sourcefn load_address(&self) -> u64
fn load_address(&self) -> u64
The address at which the image prefers to be loaded into memory.
sourcefn has_symbols(&self) -> bool
fn has_symbols(&self) -> bool
Determines whether this object exposes a public symbol table.
sourcefn symbols(
&self
) -> <BreakpadObject<'data> as ObjectLike<'data, 'object>>::SymbolIterator
fn symbols(
&self
) -> <BreakpadObject<'data> as ObjectLike<'data, 'object>>::SymbolIterator
Returns an iterator over symbols in the public symbol table.
sourcefn symbol_map(&self) -> SymbolMap<'data>
fn symbol_map(&self) -> SymbolMap<'data>
Returns an ordered map of symbols in the symbol table.
sourcefn has_debug_info(&self) -> bool
fn has_debug_info(&self) -> bool
Determines whether this object contains debug information.
sourcefn debug_session(
&self
) -> Result<<BreakpadObject<'data> as ObjectLike<'data, 'object>>::Session, <BreakpadObject<'data> as ObjectLike<'data, 'object>>::Error>
fn debug_session(
&self
) -> Result<<BreakpadObject<'data> as ObjectLike<'data, 'object>>::Session, <BreakpadObject<'data> as ObjectLike<'data, 'object>>::Error>
Constructs a debugging session. Read more
sourcefn has_unwind_info(&self) -> bool
fn has_unwind_info(&self) -> bool
Determines whether this object contains stack unwinding information.
sourcefn has_sources(&self) -> bool
fn has_sources(&self) -> bool
Determines whether this object contains embedded sources.
sourcefn is_malformed(&self) -> bool
fn is_malformed(&self) -> bool
Determines whether this object is malformed and was only partially parsed
Auto Trait Implementations
impl<'data> RefUnwindSafe for BreakpadObject<'data>
impl<'data> Send for BreakpadObject<'data>
impl<'data> Sync for BreakpadObject<'data>
impl<'data> Unpin for BreakpadObject<'data>
impl<'data> UnwindSafe for BreakpadObject<'data>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<I, T> ExtractContext<I, ()> for T
impl<I, T> ExtractContext<I, ()> for T
fn extract_context(self, _original_input: I)
fn extract_context(self, _original_input: I)
Given the context attached to a nom error, and given the original input to the nom parser, extract more the useful context information. Read more
impl<T> FmtForward for T
impl<T> FmtForward for T
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
Causes self
to use its Binary
implementation when Debug
-formatted. Read more
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
Causes self
to use its Octal
implementation when Debug
-formatted. Read more
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
impl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
Pipes by value. This is generally the method you want to use. Read more
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
Borrows self
and passes that borrow into the pipe function. Read more
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
Mutably borrows self
and passes that borrow into the pipe function. Read more
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.borrow()
into the pipe function. Read more
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
Mutably borrows self
, then passes self.borrow_mut()
into the pipe
function. Read more
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.as_ref()
into the pipe function.
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
Mutably borrows self
, then passes self.as_mut()
into the pipe
function. Read more
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.deref()
into the pipe function.
impl<I> RecreateContext<I> for I
impl<I> RecreateContext<I> for I
fn recreate_context(_original_input: I, tail: I) -> I
fn recreate_context(_original_input: I, tail: I) -> I
Given the original input, as well as the context reported by nom, recreate a context in the original string where the error occurred. Read more
impl<T> Tap for T
impl<T> Tap for T
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Immutable access to the Borrow<B>
of a value. Read more
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Mutable access to the BorrowMut<B>
of a value. Read more
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Immutable access to the AsRef<R>
view of a value. Read more
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Mutable access to the AsMut<R>
view of a value. Read more
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
Immutable access to the Deref::Target
of a value. Read more
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Mutable access to the Deref::Target
of a value. Read more
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap()
only in debug builds, and is erased in release builds.
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Calls .tap_borrow()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Calls .tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Calls .tap_ref()
only in debug builds, and is erased in release
builds. Read more
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Calls .tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more