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 builder;
      15              : pub mod dynamic;
      16              : pub mod hash;
      17              : pub mod header;
      18              : pub mod note;
      19              : pub mod relocation;
      20              : pub mod section;
      21              : pub mod segment;
      22              : pub mod symbol;
      23              : pub mod symbol_versioning;
      24              : 
      25              : #[doc(inline)]
      26              : pub use binary::Binary;
      27              : 
      28              : #[doc(inline)]
      29              : pub use header::Header;
      30              : 
      31              : #[doc(inline)]
      32              : pub use section::Section;
      33              : 
      34              : #[doc(inline)]
      35              : pub use segment::Segment;
      36              : 
      37              : #[doc(inline)]
      38              : pub use symbol::Symbol;
      39              : 
      40              : #[doc(inline)]
      41              : pub use hash::Sysv as SysvHash;
      42              : 
      43              : #[doc(inline)]
      44              : pub use hash::Gnu as GnuHash;
      45              : 
      46              : #[doc(inline)]
      47              : pub use note::Notes;
      48              : 
      49              : #[doc(inline)]
      50              : pub use dynamic::Entries as DynamicEntries;
      51              : 
      52              : #[doc(inline)]
      53              : pub use relocation::Relocation;
      54              : 
      55              : #[doc(inline)]
      56              : pub use symbol_versioning::{
      57              :     SymbolVersion, SymbolVersionAux, SymbolVersionAuxRequirement, SymbolVersionDefinition,
      58              :     SymbolVersionRequirement,
      59              : };
      60              : 
      61              : /// Parse an ELF file from the given file path
      62            0 : pub fn parse(path: &str) -> Option<Binary> {
      63            0 :     Binary::parse(path)
      64            0 : }