Line data    Source code

       1              : //! Module for processing PDB file
       2              : //!
       3              : //! This module exposes an API similar to the [`crate::dwarf`] module to process PDB
       4              : //! files.
       5              : //!
       6              : //! One can instantiate a [`crate::pdb::DebugInfo`] using either [`crate::generic::Binary::debug_info`] or
       7              : //! [`crate::pdb::load`].
       8              : //!
       9              : //! ```
      10              : //! fn read_pdb(file: &str) {
      11              : //!     let pdb = lief::pdb::load(file).unwrap();
      12              : //!     for symbol in pdb.public_symbols() {
      13              : //!         println!("name: {}", symbol.name());
      14              : //!     }
      15              : //! }
      16              : //! ```
      17              : 
      18              : use lief_ffi as ffi;
      19              : 
      20              : use crate::common::into_optional;
      21              : 
      22              : pub mod debug_info;
      23              : pub mod compilation_unit;
      24              : pub mod public_symbol;
      25              : pub mod function;
      26              : pub mod types;
      27              : pub mod build_metadata;
      28              : 
      29              : #[doc(inline)]
      30              : pub use debug_info::DebugInfo;
      31              : 
      32              : #[doc(inline)]
      33              : pub use compilation_unit::CompilationUnit;
      34              : 
      35              : #[doc(inline)]
      36              : pub use public_symbol::PublicSymbol;
      37              : 
      38              : #[doc(inline)]
      39              : pub use function::Function;
      40              : 
      41              : #[doc(inline)]
      42              : pub use types::Type;
      43              : 
      44              : #[doc(inline)]
      45              : pub use build_metadata::BuildMetadata;
      46              : 
      47              : /// Load a PDB from its file path
      48            0 : pub fn load(path: &str) -> Option<DebugInfo> {
      49            0 :     into_optional(ffi::PDB_DebugInfo::from_file(path))
      50            0 : }