Struct pdb::PDB

pub struct PDB<'s, S> { /* fields omitted */ }

PDB provides access to the data within a PDB file.

A PDB file is internally a Multi-Stream File (MSF), composed of multiple independent (and usually discontiguous) data streams on-disk. PDB provides lazy access to these data structures, which means the PDB accessor methods usually cause disk accesses.

Methods

impl<'s, S: Source<'s> + 's> PDB<'s, S>

pub fn open(source: S) -> Result<PDB<'s, S>>

Create a new PDB for a Source.

open() accesses enough of the source file to find the MSF stream table. This usually involves reading the header, a block near the end of the file, and finally the stream table itself. It does not access or validate any of the contents of the rest of the PDB.

Errors

• Error::UnimplementedFeature if the PDB file predates ~2002
• Error::UnrecognizedFileFormat if the Source does not appear to be a PDB file
• Error::IoError if returned by the Source
• Error::PageReferenceOutOfRange, Error::InvalidPageSize if the PDB file seems corrupt

pub fn pdb_information(&mut self) -> Result<PDBInformation<'s>>

Retrieve the PDBInformation for this PDB.

The PDBInformation object contains the GUID and age fields that can be used to verify that a PDB file matches a binary, as well as the stream indicies of named PDB streams.

Errors

• Error::StreamNotFound if the PDB somehow does not contain the PDB information stream
• Error::IoError if returned by the Source
• Error::PageReferenceOutOfRange if the PDB file seems corrupt

pub fn type_information(&mut self) -> Result<TypeInformation<'s>>

Retrieve the TypeInformation for this PDB.

The TypeInformation object owns a SourceView for the type information ("TPI") stream. This is usually the single largest stream of the PDB file.

Errors

• Error::StreamNotFound if the PDB somehow does not contain the type information stream
• Error::IoError if returned by the Source
• Error::PageReferenceOutOfRange if the PDB file seems corrupt
• Error::InvalidTypeInformationHeader if the type information stream header was not understood

pub fn debug_information(&mut self) -> Result<DebugInformation<'s>>

Retrieve the DebugInformation for this PDB.

The DebugInformation object owns a SourceView for the debug information ("DBI") stream.

Errors

• Error::StreamNotFound if the PDB somehow does not contain a symbol records stream
• Error::IoError if returned by the Source
• Error::PageReferenceOutOfRange if the PDB file seems corrupt
• Error::UnimplementedFeature if the debug information header predates ~1995

pub fn global_symbols(&mut self) -> Result<SymbolTable<'s>>

Retrieve the global symbol table for this PDB.

The SymbolTable object owns a SourceView for the symbol records stream. This is usually the second-largest stream of the PDB file.

The debug information stream indicates which stream is the symbol records stream, so global_symbols() accesses the debug information stream to read the header unless debug_information() was called first.

Errors

• Error::StreamNotFound if the PDB somehow does not contain a symbol records stream
• Error::IoError if returned by the Source
• Error::PageReferenceOutOfRange if the PDB file seems corrupt

If debug_information() was not already called, global_symbols() will additionally read the debug information header, in which case it can also return:

• Error::StreamNotFound if the PDB somehow does not contain a debug information stream
• Error::UnimplementedFeature if the debug information header predates ~1995

pub fn module_info<'m>(&mut self, module: &Module<'m>) -> Result<ModuleInfo<'s>>

Retrieve the module info stream for a specific Module.

Some information for each module is stored in a separate stream per-module. Modules can be retrieved from the PDB by first calling debug_information to get the debug information stream, and then calling modules on that.

Errors

• Error::StreamNotFound if the PDB does not contain this module info stream
• Error::IoError if returned by the Source
• Error::PageReferenceOutOfRange if the PDB file seems corrupt
• Error::UnimplementedFeature if the module information stream is an unsupported version

Example

let file = std::fs::File::open("fixtures/self/foo.pdb")?;
let mut pdb = pdb::PDB::open(file)?;
let dbi = pdb.debug_information()?;
let mut modules = dbi.modules()?;
if let Some(module) = modules.next()? {
    println!("module name: {}, object file name: {}",
             module.module_name(), module.object_file_name());
    let info = pdb.module_info(&module)?;
    println!("contains {} symbols", info.symbols()?.count()?);
}

pub fn raw_stream(&mut self, stream: u32) -> Result<Stream<'s>>

Retrieve a stream by its index to read its contents as bytes.

Errors

• Error::StreamNotFound if the PDB does not contain this module info stream
• Error::IoError if returned by the Source
• Error::PageReferenceOutOfRange if the PDB file seems corrupt

Example

let file = std::fs::File::open("fixtures/self/foo.pdb")?;
let mut pdb = pdb::PDB::open(file)?;
// This is the index of the "mystream" stream that was added using pdbstr.exe.
let s = pdb.raw_stream(208)?;
let mut buf = s.parse_buffer();
let len = buf.len();
let bytes = buf.take(len)?;
assert_eq!(bytes, b"hello world\n");

Trait Implementations

impl<'s, S: Debug> Debug for PDB<'s, S>

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

Formats the value using the given formatter.