#[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>),
}
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>)
Xcoff32(XcoffFile32<'data, R>)
Xcoff64(XcoffFile64<'data, R>)
Implementations§
source§impl<'data, R: ReadRef<'data>> File<'data, R>
impl<'data, R: ReadRef<'data>> File<'data, R>
sourcepub fn parse_dyld_cache_image<'cache, E: Endian>(
image: &DyldCacheImage<'data, 'cache, E, R>,
) -> Result<Self>
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.
sourcepub fn format(&self) -> BinaryFormat
pub fn format(&self) -> BinaryFormat
Return the file format.
Trait Implementations§
source§impl<'data, R> Object<'data> for File<'data, R>where
R: ReadRef<'data>,
impl<'data, R> Object<'data> for File<'data, R>where
R: ReadRef<'data>,
source§type Segment<'file> = Segment<'data, 'file, R>
where
Self: 'file,
'data: 'file
type Segment<'file> = Segment<'data, 'file, R> where Self: 'file, 'data: 'file
A loadable segment in the object file.
source§type SegmentIterator<'file> = SegmentIterator<'data, 'file, R>
where
Self: 'file,
'data: 'file
type SegmentIterator<'file> = SegmentIterator<'data, 'file, R> where Self: 'file, 'data: 'file
An iterator for the loadable segments in the object file.
source§type Section<'file> = Section<'data, 'file, R>
where
Self: 'file,
'data: 'file
type Section<'file> = Section<'data, 'file, R> where Self: 'file, 'data: 'file
A section in the object file.
source§type SectionIterator<'file> = SectionIterator<'data, 'file, R>
where
Self: 'file,
'data: 'file
type SectionIterator<'file> = SectionIterator<'data, 'file, R> where Self: 'file, 'data: 'file
An iterator for the sections in the object file.
source§type Comdat<'file> = Comdat<'data, 'file, R>
where
Self: 'file,
'data: 'file
type Comdat<'file> = Comdat<'data, 'file, R> where Self: 'file, 'data: 'file
A COMDAT section group in the object file.
source§type ComdatIterator<'file> = ComdatIterator<'data, 'file, R>
where
Self: 'file,
'data: 'file
type ComdatIterator<'file> = ComdatIterator<'data, 'file, R> where Self: 'file, 'data: 'file
An iterator for the COMDAT section groups in the object file.
source§type Symbol<'file> = Symbol<'data, 'file, R>
where
Self: 'file,
'data: 'file
type Symbol<'file> = Symbol<'data, 'file, R> where Self: 'file, 'data: 'file
A symbol in the object file.
source§type SymbolIterator<'file> = SymbolIterator<'data, 'file, R>
where
Self: 'file,
'data: 'file
type SymbolIterator<'file> = SymbolIterator<'data, 'file, R> where Self: 'file, 'data: 'file
An iterator for symbols in the object file.
source§type SymbolTable<'file> = SymbolTable<'data, 'file, R>
where
Self: 'file,
'data: 'file
type SymbolTable<'file> = SymbolTable<'data, 'file, R> where Self: 'file, 'data: 'file
A symbol table in the object file.
source§type DynamicRelocationIterator<'file> = DynamicRelocationIterator<'data, 'file, R>
where
Self: 'file,
'data: '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
fn architecture(&self) -> Architecture
Get the architecture type of the file.
source§fn sub_architecture(&self) -> Option<SubArchitecture>
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
fn is_little_endian(&self) -> bool
Return true if the file is little endian, false if it is big endian.
source§fn kind(&self) -> ObjectKind
fn kind(&self) -> ObjectKind
Return the kind of this object.
source§fn segments(&self) -> SegmentIterator<'data, '_, R> ⓘ
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>>
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>>
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> ⓘ
fn sections(&self) -> SectionIterator<'data, '_, R> ⓘ
Get an iterator for the sections in the file.
source§fn comdats(&self) -> ComdatIterator<'data, '_, R> ⓘ
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>>
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> ⓘ
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>>
fn symbol_table(&self) -> Option<SymbolTable<'data, '_, R>>
Get the debugging symbol table, if any.
source§fn dynamic_symbols(&self) -> SymbolIterator<'data, '_, R> ⓘ
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>>
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>>
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>>
fn symbol_map(&self) -> SymbolMap<SymbolMapName<'data>>
Construct a map from addresses to symbol names. Read more
source§fn object_map(&self) -> ObjectMap<'data>
fn object_map(&self) -> ObjectMap<'data>
Construct a map from addresses to symbol names and object file names. Read more
source§fn exports(&self) -> Result<Vec<Export<'data>>>
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
fn has_debug_symbols(&self) -> bool
Return true if the file contains DWARF debug information sections, false if not.
source§fn build_id(&self) -> Result<Option<&'data [u8]>>
fn build_id(&self) -> Result<Option<&'data [u8]>>
The build ID from an ELF
NT_GNU_BUILD_ID
note.source§fn gnu_debuglink(&self) -> Result<Option<(&'data [u8], u32)>>
fn gnu_debuglink(&self) -> Result<Option<(&'data [u8], u32)>>
The filename and CRC from a
.gnu_debuglink
section.source§fn gnu_debugaltlink(&self) -> Result<Option<(&'data [u8], &'data [u8])>>
fn gnu_debugaltlink(&self) -> Result<Option<(&'data [u8], &'data [u8])>>
The filename and build ID from a
.gnu_debugaltlink
section.source§fn pdb_info(&self) -> Result<Option<CodeView<'_>>>
fn pdb_info(&self) -> Result<Option<CodeView<'_>>>
The filename and GUID from the PE CodeView section.
source§fn relative_address_base(&self) -> u64
fn relative_address_base(&self) -> u64
Get the base address used for relative virtual addresses. Read more
source§fn endianness(&self) -> Endianness
fn endianness(&self) -> Endianness
Get the endianness of the file.
source§fn section_by_name(&self, section_name: &str) -> Option<Self::Section<'_>>
fn section_by_name(&self, section_name: &str) -> Option<Self::Section<'_>>
Get the section named
section_name
, if such a section exists. Read moresource§fn symbol_by_name<'file>(
&'file self,
symbol_name: &str,
) -> Option<Self::Symbol<'file>>
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>>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more