Struct object::read::pe::file::PeFile

pub struct PeFile<'data, Pe, R = &'data [u8]>
where
    Pe: ImageNtHeaders,
    R: ReadRef<'data>,
{
    pub(super) dos_header: &'data ImageDosHeader,
    pub(super) nt_headers: &'data Pe,
    pub(super) data_directories: DataDirectories<'data>,
    pub(super) common: CoffCommon<'data, R>,
    pub(super) data: R,
}

A PE image file.

Most functionality is provided by the Object trait implementation.

Fields

dos_header: &'data ImageDosHeader

nt_headers: &'data Pe

data_directories: DataDirectories<'data>

common: CoffCommon<'data, R>

data: R

Implementations

impl<'data, Pe, R> PeFile<'data, Pe, R>

where Pe: ImageNtHeaders, R: ReadRef<'data>,

pub fn parse(data: R) -> Result<Self>

Parse the raw PE file data.

pub fn data(&self) -> R

Returns this binary data.

pub fn dos_header(&self) -> &'data ImageDosHeader

Return the DOS header of this file.

pub fn nt_headers(&self) -> &'data Pe

Return the NT Headers of this file.

pub fn rich_header_info(&self) -> Option<RichHeaderInfo<'_>>

Returns information about the rich header of this file (if any).

pub fn section_table(&self) -> SectionTable<'data>

Returns the section table of this binary.

pub fn data_directories(&self) -> DataDirectories<'data>

Returns the data directories of this file.

pub fn data_directory(&self, id: usize) -> Option<&'data ImageDataDirectory>

Returns the data directory at the given index.

pub fn export_table(&self) -> Result<Option<ExportTable<'data>>>

Returns the export table of this file.

The export table is located using the data directory.

pub fn import_table(&self) -> Result<Option<ImportTable<'data>>>

Returns the import table of this file.

The import table is located using the data directory.

pub(super) fn section_alignment(&self) -> u64

Trait Implementations

impl<'data, Pe, R> Debug for PeFile<'data, Pe, R>

where Pe: ImageNtHeaders + Debug, R: ReadRef<'data> + Debug,

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

Formats the value using the given formatter.

impl<'data, Pe, R> Object<'data> for PeFile<'data, Pe, R>

where Pe: ImageNtHeaders, R: ReadRef<'data>,

type Segment<'file> = PeSegment<'data, 'file, Pe, R> where Self: 'file, 'data: 'file

A loadable segment in the object file.

type SegmentIterator<'file> = PeSegmentIterator<'data, 'file, Pe, R> where Self: 'file, 'data: 'file

An iterator for the loadable segments in the object file.

type Section<'file> = PeSection<'data, 'file, Pe, R> where Self: 'file, 'data: 'file

A section in the object file.

type SectionIterator<'file> = PeSectionIterator<'data, 'file, Pe, R> where Self: 'file, 'data: 'file

An iterator for the sections in the object file.

type Comdat<'file> = PeComdat<'data, 'file, Pe, R> where Self: 'file, 'data: 'file

A COMDAT section group in the object file.

type ComdatIterator<'file> = PeComdatIterator<'data, 'file, Pe, R> where Self: 'file, 'data: 'file

An iterator for the COMDAT section groups in the object file.

type Symbol<'file> = CoffSymbol<'data, 'file, R> where Self: 'file, 'data: 'file

A symbol in the object file.

type SymbolIterator<'file> = CoffSymbolIterator<'data, 'file, R> where Self: 'file, 'data: 'file

An iterator for symbols in the object file.

type SymbolTable<'file> = CoffSymbolTable<'data, 'file, R> where Self: 'file, 'data: 'file

A symbol table in the object file.

type DynamicRelocationIterator<'file> = NoDynamicRelocationIterator where Self: 'file, 'data: 'file

An iterator for the dynamic relocations in the file.

fn architecture(&self) -> Architecture

Get the architecture type of the file.

fn sub_architecture(&self) -> Option<SubArchitecture>

Get the sub-architecture type of the file if known.

fn is_little_endian(&self) -> bool

Return true if the file is little endian, false if it is big endian.

fn is_64(&self) -> bool

Return true if the file can contain 64-bit addresses.

fn kind(&self) -> ObjectKind

Return the kind of this object.

fn segments(&self) -> PeSegmentIterator<'data, '_, Pe, R>

Get an iterator for the loadable segments in the file.

fn section_by_name_bytes<'file>( &'file self, section_name: &[u8], ) -> Option<PeSection<'data, 'file, Pe, R>>

Like Self::section_by_name, but allows names that are not UTF-8.

fn section_by_index( &self, index: SectionIndex, ) -> Result<PeSection<'data, '_, Pe, R>>

Get the section at the given index.

fn sections(&self) -> PeSectionIterator<'data, '_, Pe, R>

Get an iterator for the sections in the file.

fn comdats(&self) -> PeComdatIterator<'data, '_, Pe, R>

Get an iterator for the COMDAT section groups in the file.

fn symbol_by_index( &self, index: SymbolIndex, ) -> Result<CoffSymbol<'data, '_, R>>

Get the debugging symbol at the given index.

fn symbols(&self) -> CoffSymbolIterator<'data, '_, R>

Get an iterator for the debugging symbols in the file.

fn symbol_table(&self) -> Option<CoffSymbolTable<'data, '_, R>>

Get the debugging symbol table, if any.

fn dynamic_symbols(&self) -> CoffSymbolIterator<'data, '_, R>

Get an iterator for the dynamic linking symbols in the file.

fn dynamic_symbol_table(&self) -> Option<CoffSymbolTable<'data, '_, R>>

Get the dynamic linking symbol table, if any.

fn dynamic_relocations(&self) -> Option<NoDynamicRelocationIterator>

Get the dynamic relocations for this file.

fn imports(&self) -> Result<Vec<Import<'data>>>

Get the imported symbols.

fn exports(&self) -> Result<Vec<Export<'data>>>

Get the exported symbols that expose both a name and an address.

fn pdb_info(&self) -> Result<Option<CodeView<'_>>>

The filename and GUID from the PE CodeView section.

fn has_debug_symbols(&self) -> bool

Return true if the file contains DWARF debug information sections, false if not.

fn relative_address_base(&self) -> u64

Get the base address used for relative virtual addresses.

fn entry(&self) -> u64

Get the virtual address of the entry point of the binary.

fn flags(&self) -> FileFlags

File flags that are specific to each file format.

fn endianness(&self) -> Endianness

Get the endianness of the file.

fn section_by_name(&self, section_name: &str) -> Option<Self::Section<'_>>

Get the section named section_name, if such a section exists.

fn symbol_by_name<'file>( &'file self, symbol_name: &str, ) -> Option<Self::Symbol<'file>>

Get the symbol named symbol_name, if the symbol exists.

fn symbol_by_name_bytes<'file>( &'file self, symbol_name: &[u8], ) -> Option<Self::Symbol<'file>>

Like Self::symbol_by_name, but allows names that are not UTF-8.

fn symbol_map(&self) -> SymbolMap<SymbolMapName<'data>>

Construct a map from addresses to symbol names.

fn object_map(&self) -> ObjectMap<'data>

Construct a map from addresses to symbol names and object file names.

fn mach_uuid(&self) -> Result<Option<[u8; 16]>>

The UUID from a Mach-O LC_UUID load command.

fn build_id(&self) -> Result<Option<&'data [u8]>>

The build ID from an ELF NT_GNU_BUILD_ID note.

fn gnu_debuglink(&self) -> Result<Option<(&'data [u8], u32)>>

The filename and CRC from a .gnu_debuglink section.

fn gnu_debugaltlink(&self) -> Result<Option<(&'data [u8], &'data [u8])>>

The filename and build ID from a .gnu_debugaltlink section.

impl<'data, Pe, R> Sealed for PeFile<'data, Pe, R>

where Pe: ImageNtHeaders, R: ReadRef<'data>,