Enum symbolic_debuginfo::Object

pub enum Object<'data> {
    Breakpad(BreakpadObject<'data>),
    Elf(ElfObject<'data>),
    MachO(MachObject<'data>),
    Pdb(PdbObject<'data>),
    Pe(PeObject<'data>),
    SourceBundle(SourceBundle<'data>),
    Wasm(WasmObject<'data>),
    PortablePdb(PortablePdbObject<'data>),
}

A generic object file providing uniform access to various file formats.

Variants

Breakpad(BreakpadObject<'data>)

Breakpad ASCII symbol.

Elf(ElfObject<'data>)

Executable and Linkable Format, used on Linux.

MachO(MachObject<'data>)

Mach Objects, used on macOS and iOS derivatives.

Pdb(PdbObject<'data>)

Program Database, the debug companion format on Windows.

Pe(PeObject<'data>)

Portable Executable, an extension of COFF used on Windows.

SourceBundle(SourceBundle<'data>)

A source bundle.

Wasm(WasmObject<'data>)

A WASM file.

PortablePdb(PortablePdbObject<'data>)

A Portable PDB, a debug companion format for CLR languages.

Implementations

impl<'data> Object<'data>

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

Tests whether the buffer could contain an object.

pub fn peek(data: &[u8]) -> FileFormat

Tries to infer the object type from the start of the given buffer.

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

Tries to parse a supported object from the given slice.

pub fn file_format(&self) -> FileFormat

The container format of this file, corresponding to the variant of this instance.

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

The code identifier of this object.

This is a platform-dependent string of variable length that always refers to the code file (e.g. executable or library), even if this object is a debug file. See the variants for the semantics of this code identifier.

pub fn debug_id(&self) -> DebugId

The debug information identifier of this object.

For platforms that use different identifiers for their code and debug files, this always refers to the debug file, regardless whether this object is a debug file or not.

pub fn arch(&self) -> Arch

The CPU architecture of this object.

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.

pub fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

pub fn symbols(&self) -> SymbolIterator<'data, '_>

Returns an iterator over symbols in the public symbol table.

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

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<ObjectDebugSession<'data>, ObjectError>

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.

Objects that do not support debugging or do not contain debugging information return an empty debug session. This only returns an error if constructing the debug session fails due to invalid debug data in the object.

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.

pub fn has_sources(&self) -> bool

Determines whether this object contains embedded source

pub fn is_malformed(&self) -> bool

Determines whether this object is malformed and was only partially parsed

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

Returns the raw data of the underlying buffer.

Trait Implementations

impl<'slf, 'data: 'slf> AsSelf<'slf> for Object<'data>

type Ref = Object<'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.

impl<'data> Debug for Object<'data>

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

Formats the value using the given formatter.

impl<'data: 'object, 'object> ObjectLike<'data, 'object> for Object<'data>

type Error = ObjectError

Errors thrown when reading information from this object.

type Session = ObjectDebugSession<'data>

A session that allows optimized access to debugging information.

type SymbolIterator = SymbolIterator<'data, 'object>

The iterator over the symbols in the public symbol table.

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 symbol_map(&self) -> SymbolMap<'data>

Returns an ordered map of symbols in the symbol table.

fn symbols(&'object self) -> Self::SymbolIterator

Returns an iterator over symbols in the public 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 has_sources(&self) -> bool

Determines whether this object contains embedded sources.

fn is_malformed(&self) -> bool

Determines whether this object is malformed and was only partially parsed