Enum File

#[non_exhaustive]
pub enum File<'data, R: ReadRef<'data> = &'data [u8]> {
    Coff(CoffFile<'data, R>),
    CoffBig(CoffBigFile<'data, R>),
    Elf32(ElfFile32<'data, Endianness, R>),
    Elf64(ElfFile64<'data, Endianness, R>),
    MachO32(MachOFile32<'data, Endianness, R>),
    MachO64(MachOFile64<'data, Endianness, R>),
    Pe32(PeFile32<'data, R>),
    Pe64(PeFile64<'data, R>),
    Xcoff32(XcoffFile32<'data, R>),
    Xcoff64(XcoffFile64<'data, R>),
}

An object file that can be any supported file format.

Most functionality is provided by the Object trait implementation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Coff(CoffFile<'data, R>)

CoffBig(CoffBigFile<'data, R>)

Elf32(ElfFile32<'data, Endianness, R>)

Elf64(ElfFile64<'data, Endianness, R>)

MachO32(MachOFile32<'data, Endianness, R>)

MachO64(MachOFile64<'data, Endianness, R>)

Pe32(PeFile32<'data, R>)

Pe64(PeFile64<'data, R>)

Xcoff32(XcoffFile32<'data, R>)

Xcoff64(XcoffFile64<'data, R>)

Implementations

impl<'data, R: ReadRef<'data>> File<'data, R>

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

Parse the raw file data.

pub fn parse_dyld_cache_image<'cache, E: Endian>( image: &DyldCacheImage<'data, 'cache, E, R>, ) -> Result<Self>

Parse a Mach-O image from the dyld shared cache.

pub fn format(&self) -> BinaryFormat

Return the file format.

Trait Implementations

impl<'data, R: Debug + ReadRef<'data>> Debug for File<'data, R>

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

Formats the value using the given formatter.

impl<'data, R> Object<'data> for File<'data, R>

where R: ReadRef<'data>,

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

A loadable segment in the object file.

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

An iterator for the loadable segments in the object file.

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

A section in the object file.

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

An iterator for the sections in the object file.

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

A COMDAT section group in the object file.

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

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

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

A symbol in the object file.

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

An iterator for symbols in the object file.

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

A symbol table in the object file.

type DynamicRelocationIterator<'file> = DynamicRelocationIterator<'data, 'file, R> 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) -> SegmentIterator<'data, '_, R>

Get an iterator for the loadable segments in the file.

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

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

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

Get the section at the given index.

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

Get an iterator for the sections in the file.

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

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

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

Get the debugging symbol at the given index.

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

Get an iterator for the debugging symbols in the file.

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

Get the debugging symbol table, if any.

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

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

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

Get the dynamic linking symbol table, if any.

fn dynamic_relocations(&self) -> Option<DynamicRelocationIterator<'data, '_, R>>

Get the dynamic relocations for this file.

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 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 has_debug_symbols(&self) -> bool

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

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.

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

The filename and GUID from the PE CodeView section.

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.