Enum object::read::File

source ·
#[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>), Wasm(WasmFile<'data, R>), Xcoff32(XcoffFile32<'data, R>), Xcoff64(XcoffFile64<'data, R>), }
Expand description

An object file that can be any supported file format.

Most functionality is provided by the Object trait implementation.

Variants (Non-exhaustive)§

This enum is marked as 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>)

§

Wasm(WasmFile<'data, R>)

§

Xcoff32(XcoffFile32<'data, R>)

§

Xcoff64(XcoffFile64<'data, R>)

Implementations§

source§

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

source

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

Parse the raw file data.

source

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.

source

pub fn format(&self) -> BinaryFormat

Return the file format.

Trait Implementations§

source§

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

source§

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

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

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. 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) -> SegmentIterator<'data, '_, 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<Section<'data, 'file, R>>

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

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

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

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

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

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

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

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

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

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

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

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

Get the debugging symbol table, if any.
source§

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

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

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

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

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

Get the dynamic relocations for this file. Read more
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 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 has_debug_symbols(&self) -> bool

Return true if the file contains DWARF debug information sections, false if not.
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.
source§

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

The filename and GUID from the PE CodeView section.
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.

Auto Trait Implementations§

§

impl<'data, R> Freeze for File<'data, R>
where R: Freeze,

§

impl<'data, R> RefUnwindSafe for File<'data, R>
where R: RefUnwindSafe,

§

impl<'data, R> Send for File<'data, R>
where R: Send,

§

impl<'data, R> Sync for File<'data, R>
where R: Sync,

§

impl<'data, R> Unpin for File<'data, R>
where R: Unpin,

§

impl<'data, R> UnwindSafe for File<'data, R>
where R: UnwindSafe,

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>,

§

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>,

§

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.