Line data    Source code

       1              : //! Module for the ELF file format support in LIEF.
       2              : //!
       3              : //! The [`Binary`] structure exposes the main API to inspect an ELF file. It can be instantiated,
       4              : //! using either: [`crate::elf::parse`], [`crate::elf::Binary::parse`] or [`crate::Binary::parse`]
       5              : //!
       6              : //! ```
       7              : //! let elf = lief::elf::parse("/bin/ls").unwrap();
       8              : //! for section in elf.sections() {
       9              : //!     println!("section: {}", section.name());
      10              : //! }
      11              : //! ```
      12              : 
      13              : pub mod binary;
      14              : pub mod dynamic;
      15              : pub mod hash;
      16              : pub mod header;
      17              : pub mod note;
      18              : pub mod relocation;
      19              : pub mod section;
      20              : pub mod segment;
      21              : pub mod symbol;
      22              : pub mod symbol_versioning;
      23              : 
      24              : #[doc(inline)]
      25              : pub use binary::Binary;
      26              : 
      27              : #[doc(inline)]
      28              : pub use header::Header;
      29              : 
      30              : #[doc(inline)]
      31              : pub use section::Section;
      32              : 
      33              : #[doc(inline)]
      34              : pub use segment::Segment;
      35              : 
      36              : #[doc(inline)]
      37              : pub use symbol::Symbol;
      38              : 
      39              : #[doc(inline)]
      40              : pub use hash::Sysv as SysvHash;
      41              : 
      42              : #[doc(inline)]
      43              : pub use hash::Gnu as GnuHash;
      44              : 
      45              : #[doc(inline)]
      46              : pub use note::Notes;
      47              : 
      48              : #[doc(inline)]
      49              : pub use dynamic::Entries as DynamicEntries;
      50              : 
      51              : #[doc(inline)]
      52              : pub use relocation::Relocation;
      53              : 
      54              : #[doc(inline)]
      55              : pub use symbol_versioning::{
      56              :     SymbolVersion, SymbolVersionAux, SymbolVersionAuxRequirement, SymbolVersionDefinition,
      57              :     SymbolVersionRequirement,
      58              : };
      59              : 
      60              : /// Parse an ELF file from the given file path
      61            0 : pub fn parse(path: &str) -> Option<Binary> {
      62            0 :     Binary::parse(path)
      63            0 : }