Struct object::read::pe::PeFile

source ·
pub struct PeFile<'data, Pe, R = &'data [u8]>
where Pe: ImageNtHeaders, R: ReadRef<'data>,
{ /* private fields */ }
Expand description

A PE image file.

Most functionality is provided by the Object trait implementation.

Implementations§

source§

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

source

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

Parse the raw PE file data.

source

pub fn data(&self) -> R

Returns this binary data.

source

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

Return the DOS header of this file.

source

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

Return the NT Headers of this file.

source

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

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

source

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

Returns the section table of this binary.

source

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

Returns the data directories of this file.

source

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

Returns the data directory at the given index.

source

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.

source

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.

Trait Implementations§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<'data, Pe, R> Object<'data> for PeFile<'data, Pe, R>
where Pe: ImageNtHeaders, R: ReadRef<'data>,

source§

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

A loadable segment in the object file.
source§

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

An iterator for the loadable segments in the object file.
source§

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

A section in the object file.
source§

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

An iterator for the sections in the object file.
source§

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

A COMDAT section group in the object file.
source§

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

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

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

A symbol in the object file.
source§

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

An iterator for symbols in the object file.
source§

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

A symbol table in the object file.
source§

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

An iterator for the dynamic relocations in the file. Read more
source§

fn architecture(&self) -> Architecture

Get the architecture type of the file.
source§

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

Get the sub-architecture type of the file if known. Read more
source§

fn is_little_endian(&self) -> bool

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

fn is_64(&self) -> bool

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

fn kind(&self) -> ObjectKind

Return the kind of this object.
source§

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

Get an iterator for the loadable segments in the file. Read more
source§

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.
source§

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

Get the section at the given index. Read more
source§

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

Get an iterator for the sections in the file.
source§

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

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

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

Get the debugging symbol at the given index. Read more
source§

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

Get an iterator for the debugging symbols in the file. Read more
source§

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

Get the debugging symbol table, if any.
source§

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

Get an iterator for the dynamic linking symbols in the file. Read more
source§

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

Get the dynamic linking symbol table, if any. Read more
source§

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

Get the dynamic relocations for this file. Read more
source§

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

Get the imported symbols.
source§

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

Get the exported symbols that expose both a name and an address. Read more
source§

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

The filename and GUID from the PE CodeView section.
source§

fn has_debug_symbols(&self) -> bool

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

fn relative_address_base(&self) -> u64

Get the base address used for relative virtual addresses. Read more
source§

fn entry(&self) -> u64

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

fn flags(&self) -> FileFlags

File flags that are specific to each file format.
source§

fn endianness(&self) -> Endianness

Get the endianness of the file.
source§

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

Get the section named section_name, if such a section exists. Read more
source§

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

Get the symbol named symbol_name, if the symbol exists.
source§

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.
source§

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

Construct a map from addresses to symbol names. Read more
source§

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

Construct a map from addresses to symbol names and object file names. Read more
source§

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

The UUID from a Mach-O LC_UUID load command.
source§

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

The build ID from an ELF NT_GNU_BUILD_ID note.
The filename and CRC from a .gnu_debuglink section.
The filename and build ID from a .gnu_debugaltlink section.

Auto Trait Implementations§

§

impl<'data, Pe, R> Freeze for PeFile<'data, Pe, R>
where R: Freeze,

§

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

§

impl<'data, Pe, R> Send for PeFile<'data, Pe, R>
where R: Send, Pe: Sync,

§

impl<'data, Pe, R> Sync for PeFile<'data, Pe, R>
where R: Sync, Pe: Sync,

§

impl<'data, Pe, R> Unpin for PeFile<'data, Pe, R>
where R: Unpin,

§

impl<'data, Pe, R> UnwindSafe for PeFile<'data, Pe, R>
where R: UnwindSafe, Pe: RefUnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.