Struct PortablePdb 

pub struct PortablePdb<'data> { /* private fields */ }

A parsed Portable PDB file.

This can be converted to a PortablePdbCache using the PortablePdbCacheConverter::process_portable_pdb method.

Implementations

impl<'data> PortablePdb<'data>

pub fn peek(buf: &[u8]) -> bool

Checks whether the provided buffer could potentially be a Portable PDB file, without fully parsing it.

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

Parses the provided buffer into a Portable PDB file.

pub fn pdb_id(&self) -> Option<DebugId>

Reads this file’s PDB ID from its #PDB stream.

pub fn has_debug_info(&self) -> bool

Returns true if this portable pdb file contains method debug information.

pub fn get_document(&self, idx: usize) -> Result<Document, FormatError>

Get source file referenced by this PDB.

Given index must be between 1 and get_documents_count().

pub fn get_documents_count(&self) -> Result<usize, FormatError>

Get the number of source files referenced by this PDB.

pub fn get_embedded_sources( &self, ) -> Result<EmbeddedSourceIterator<'_, 'data>, FormatError>

An iterator over source files contents’ embedded in this PDB.

pub fn has_source_links(&self) -> Result<bool, FormatError>

Whether this PPDB contains source-link mappings.

pub fn get_source_link(&self, document: &Document) -> Option<Cow<'_, str>>

Tries to resolve given document as a source link (URL). Make sure to try Self::get_embedded_sources first when looking for a source file, because function may return a link that actually doesn’t exist (e.g. file is in .gitignore). In that case, it’s usually the case that the file is embedded in the PPDB instead.

Trait Implementations

impl<'data> Clone for PortablePdb<'data>

fn clone(&self) -> PortablePdb<'data>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PortablePdb<'_>

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

Formats the value using the given formatter.