pdb/
lib.rs

1// Copyright 2017 pdb Developers
2//
3// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
4// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
5// http://opensource.org/licenses/MIT>, at your option. This file may not be
6// copied, modified, or distributed except according to those terms.
7
8//! The `pdb` create parses Microsoft PDB (Program Database) files. PDB files contain debugging
9//! information produced by most compilers that target Windows, including information about symbols,
10//! types, modules, and so on.
11//!
12//! # Usage
13//!
14//! PDB files are accessed via the [`pdb::PDB`] object.
15//!
16//! # Example
17//!
18//! ```
19//! # use pdb::FallibleIterator;
20//! #
21//! # fn test() -> pdb::Result<usize> {
22//! let file = std::fs::File::open("fixtures/self/foo.pdb")?;
23//! let mut pdb = pdb::PDB::open(file)?;
24//!
25//! let symbol_table = pdb.global_symbols()?;
26//! let address_map = pdb.address_map()?;
27//!
28//! # let mut count: usize = 0;
29//! let mut symbols = symbol_table.iter();
30//! while let Some(symbol) = symbols.next()? {
31//!     match symbol.parse() {
32//!         Ok(pdb::SymbolData::Public(data)) if data.function => {
33//!             // we found the location of a function!
34//!             let rva = data.offset.to_rva(&address_map).unwrap_or_default();
35//!             println!("{} is {}", rva, data.name);
36//!             # count += 1;
37//!         }
38//!         _ => {}
39//!     }
40//! }
41//!
42//! # Ok(count)
43//! # }
44//! # assert!(test().expect("test") > 2000);
45//! ```
46
47#![warn(missing_docs)]
48
49// modules
50mod common;
51mod dbi;
52mod framedata;
53mod modi;
54mod msf;
55mod omap;
56mod pdb;
57mod pdbi;
58mod pe;
59mod source;
60mod strings;
61mod symbol;
62mod tpi;
63
64// exports
65pub use crate::common::*;
66pub use crate::dbi::*;
67pub use crate::framedata::*;
68pub use crate::modi::*;
69pub use crate::omap::*;
70pub use crate::pdb::*;
71pub use crate::pdbi::*;
72pub use crate::pe::*;
73pub use crate::source::*;
74pub use crate::strings::*;
75pub use crate::symbol::*;
76pub use crate::tpi::*;
77
78// re-export FallibleIterator for convenience
79#[doc(no_inline)]
80pub use fallible_iterator::FallibleIterator;
pdb/lib.rs

pdb/
lib.rs
