Trait symbolic::debuginfo::ObjectLike

pub trait ObjectLike<'data, 'object> {
    type Error;
    type Session: for<'session> DebugSession<'session, Error = Self::Error>;
    type SymbolIterator: Iterator<Item = Symbol<'data>>;

    fn file_format(&self) -> FileFormat;
    fn code_id(&self) -> Option<CodeId>;
    fn debug_id(&self) -> DebugId;
    fn arch(&self) -> Arch;
    fn kind(&self) -> ObjectKind;
    fn load_address(&self) -> u64;
    fn has_symbols(&self) -> bool;
    fn symbols(&'object self) -> Self::SymbolIterator;
    fn symbol_map(&self) -> SymbolMap<'data>;
    fn has_debug_info(&self) -> bool;
    fn debug_session(&'object self) -> Result<Self::Session, Self::Error>;
    fn has_unwind_info(&self) -> bool;
    fn has_sources(&self) -> bool;
    fn is_malformed(&self) -> bool;
}

An object containing debug information.

Required Associated Types

type Error

Errors thrown when reading information from this object.

type Session: for<'session> DebugSession<'session, Error = Self::Error>

A session that allows optimized access to debugging information.

type SymbolIterator: Iterator<Item = Symbol<'data>>

The iterator over the symbols in the public symbol table.

Required Methods

fn file_format(&self) -> FileFormat

The container format of this file.

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

The code identifier of this object.

The identifier can be None if it cannot be determined from the object file, for instance, because the identifier was stripped in the build process.

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(&'object self) -> Self::SymbolIterator

Returns an iterator over symbols in the public symbol table.

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

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(&'object self) -> Result<Self::Session, Self::Error>

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.

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

Implementors

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

type Error = ObjectError

type Session = ObjectDebugSession<'data>

type SymbolIterator = SymbolIterator<'data, 'object>

impl<'data, 'object> ObjectLike<'data, 'object> for BreakpadObject<'data>where
    'data: 'object,

type Error = BreakpadError

type Session = BreakpadDebugSession<'data>

type SymbolIterator = BreakpadSymbolIterator<'data>

impl<'data, 'object> ObjectLike<'data, 'object> for ElfObject<'data>where
    'data: 'object,

type Error = DwarfError

type Session = DwarfDebugSession<'data>

type SymbolIterator = ElfSymbolIterator<'data, 'object>

impl<'data, 'object> ObjectLike<'data, 'object> for MachObject<'data>where
    'data: 'object,

type Error = DwarfError

type Session = DwarfDebugSession<'data>

type SymbolIterator = MachOSymbolIterator<'data>

impl<'data, 'object> ObjectLike<'data, 'object> for PdbObject<'data>where
    'data: 'object,

type Error = PdbError

type Session = PdbDebugSession<'data>

type SymbolIterator = PdbSymbolIterator<'data, 'object>

impl<'data, 'object> ObjectLike<'data, 'object> for PeObject<'data>where
    'data: 'object,

type Error = PeError

type Session = PeDebugSession<'data>

type SymbolIterator = PeSymbolIterator<'data, 'object>

impl<'data, 'object> ObjectLike<'data, 'object> for PortablePdbObject<'data>

type Error = Infallible

type Session = PortablePdbDebugSession

type SymbolIterator = Empty<Symbol<'data>>

impl<'data, 'object> ObjectLike<'data, 'object> for SourceBundle<'data>where
    'data: 'object,

type Error = SourceBundleError

type Session = SourceBundleDebugSession<'data>

type SymbolIterator = Empty<Symbol<'data>>

impl<'data, 'object> ObjectLike<'data, 'object> for WasmObject<'data>where
    'data: 'object,

type Error = DwarfError

type Session = DwarfDebugSession<'data>

type SymbolIterator = WasmSymbolIterator<'data, 'object>