Struct symbolic::debuginfo::breakpad::BreakpadObject
source · 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> ⓘ
pub fn symbols(&self) -> BreakpadSymbolIterator<'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> ⓘ
pub fn info_records(&self) -> BreakpadInfoRecords<'data> ⓘ
Returns an iterator over info records.
sourcepub fn file_records(&self) -> BreakpadFileRecords<'data> ⓘ
pub fn file_records(&self) -> BreakpadFileRecords<'data> ⓘ
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> ⓘ
pub fn public_records(&self) -> BreakpadPublicRecords<'data> ⓘ
Returns an iterator over public symbol records.
sourcepub fn func_records(&self) -> BreakpadFuncRecords<'data> ⓘ
pub fn func_records(&self) -> BreakpadFuncRecords<'data> ⓘ
Returns an iterator over function records.
sourcepub fn stack_records(&self) -> BreakpadStackRecords<'data> ⓘ
pub fn stack_records(&self) -> BreakpadStackRecords<'data> ⓘ
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>
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
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
type Session = BreakpadDebugSession<'data>
type Session = BreakpadDebugSession<'data>
type SymbolIterator = BreakpadSymbolIterator<'data>
type SymbolIterator = BreakpadSymbolIterator<'data>
sourcefn file_format(&self) -> FileFormat
fn file_format(&self) -> FileFormat
sourcefn kind(&self) -> ObjectKind
fn kind(&self) -> ObjectKind
sourcefn load_address(&self) -> u64
fn load_address(&self) -> u64
sourcefn has_symbols(&self) -> bool
fn has_symbols(&self) -> bool
sourcefn symbols(
&self
) -> <BreakpadObject<'data> as ObjectLike<'data, 'object>>::SymbolIterator
fn symbols(
&self
) -> <BreakpadObject<'data> as ObjectLike<'data, 'object>>::SymbolIterator
sourcefn symbol_map(&self) -> SymbolMap<'data>
fn symbol_map(&self) -> SymbolMap<'data>
sourcefn has_debug_info(&self) -> bool
fn has_debug_info(&self) -> bool
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>
sourcefn has_unwind_info(&self) -> bool
fn has_unwind_info(&self) -> bool
sourcefn has_sources(&self) -> bool
fn has_sources(&self) -> bool
sourcefn is_malformed(&self) -> bool
fn is_malformed(&self) -> bool
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 Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
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)
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,
self
to use its Binary
implementation when Debug
-formatted.fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read morefn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read morefn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
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
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
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) -> Rwhere
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) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
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
impl<T> Tap for T
impl<T> Tap for T
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
Borrow<B>
of a value. Read morefn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
BorrowMut<B>
of a value. Read morefn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
AsRef<R>
view of a value. Read morefn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
AsMut<R>
view of a value. Read morefn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
Deref::Target
of a value. Read morefn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Deref::Target
of a value. Read morefn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.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
.tap_mut()
only in debug builds, and is erased in release
builds. Read morefn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds. Read morefn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read morefn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds. Read morefn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more