Struct symbolic::debuginfo::pdb::PdbObject

pub struct PdbObject<'d> { /* fields omitted */ }

Program Database, the debug companion format on Windows.

This object is a sole debug companion to PeObject.

Implementations

impl<'d> PdbObject<'d>

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

Tests whether the buffer could contain an PDB object.

pub fn parse(data: &'d [u8]) -> Result<PdbObject<'d>, PdbError>

Tries to parse a PDB object from the given slice.

pub fn file_format(&self) -> FileFormat

The container file format, which is always FileFormat::Pdb.

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

The code identifier of this object, always None.

PDB files do not contain sufficient information to compute the code identifier, since they are lacking the relevant parts of the PE header.

pub fn debug_id(&self) -> DebugId

The debug information identifier of this PDB.

The PDB stores a specific header that contains GUID and age bits. Additionally, Microsoft uses the file name of the PDB to avoid GUID collisions. In most contexts, however, it is sufficient to rely on the uniqueness of the GUID to identify a PDB.

The same information is also stored in a header in the corresponding PE file, which can be used to locate a PDB from a PE.

pub fn arch(&self) -> Arch

The CPU architecture of this object, as specified in the debug information stream (DBI).

pub fn kind(&self) -> ObjectKind

The kind of this object, which is always Debug.

pub fn load_address(&self) -> u64

The address at which the image prefers to be loaded into memory.

The PDB only stores relative addresses, and more importantly, does not provide sufficient information to compute the original PE's load address. The according PE, however does feature a load address (called image_base). See PeObject::load_address for more information.

pub fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

pub fn symbols(&self) -> PdbSymbolIterator<'d>

Returns an iterator over symbols in the public symbol table.

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

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 has_sources(&self) -> bool

Determines whether this object contains embedded source.

pub fn debug_session(&self) -> Result<PdbDebugSession<'d>, PdbError>

Constructs a debugging session.

pub fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

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

Returns the raw data of the ELF file.

Trait Implementations

impl<'slf, 'd> AsSelf<'slf> for PdbObject<'d> where
    'd: 'slf, 

type Ref = PdbObject<'slf>

The Self type with 'slf lifetimes, returned by as_self.

fn as_self(&'slf self) -> &'slf <PdbObject<'d> as AsSelf<'slf>>::Ref

Returns a reference to self with downcasted lifetime.

impl<'_> Debug for PdbObject<'_>

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

Formats the value using the given formatter.

impl<'d> ObjectLike for PdbObject<'d>

type Error = PdbError

Errors thrown when reading information from this object.

type Session = PdbDebugSession<'d>

A session that allows optimized access to debugging information.

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 symbols(&self) -> Box<dyn Iterator<Item = Symbol>>

Returns an iterator over symbols in the public symbol table.

fn symbol_map(&self) -> SymbolMap

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(
    &self
) -> Result<<PdbObject<'d> as ObjectLike>::Session, <PdbObject<'d> as ObjectLike>::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.

impl<'_> Send for PdbObject<'_>

impl<'_> Sync for PdbObject<'_>