Struct object::read::File[−][src]

pub struct File<'data, R: ReadRef<'data> = &'data [u8]> { /* fields omitted */ }
Expand description

An object file.

Most functionality is provided by the Object trait implementation.

Implementations

impl<'data, R: ReadRef<'data>> File<'data, R>[src]

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

Parse the raw file data.

pub fn parse_at(data: R, offset: u64) -> Result<Self>[src]

Parse the raw file data at an arbitrary offset inside the input data.

Currently, this is only supported for Mach-O images. This can be used for parsing Mach-O images inside the dyld shared cache, where multiple images, located at different offsets, share the same address space.

pub fn format(&self) -> BinaryFormat[src]

Return the file format.

Trait Implementations

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

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

Formats the value using the given formatter. Read more

impl<'data, 'file, R> Object<'data, 'file> for File<'data, R> where
    'data: 'file,
    R: 'file + ReadRef<'data>, [src]

type Segment = Segment<'data, 'file, R>

A segment in the object file.

type SegmentIterator = SegmentIterator<'data, 'file, R>

An iterator over the segments in the object file.

type Section = Section<'data, 'file, R>

A section in the object file.

type SectionIterator = SectionIterator<'data, 'file, R>

An iterator over the sections in the object file.

type Comdat = Comdat<'data, 'file, R>

A COMDAT section group in the object file.

type ComdatIterator = ComdatIterator<'data, 'file, R>

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

type Symbol = Symbol<'data, 'file, R>

A symbol in the object file.

type SymbolIterator = SymbolIterator<'data, 'file, R>

An iterator over symbols in the object file.

type SymbolTable = SymbolTable<'data, 'file, R>

A symbol table in the object file.

type DynamicRelocationIterator = DynamicRelocationIterator<'data, 'file, R>

An iterator over dynamic relocations in the file. Read more

fn architecture(&self) -> Architecture[src]

Get the architecture type of the file.

fn is_little_endian(&self) -> bool[src]

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

fn is_64(&self) -> bool[src]

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

fn segments(&'file self) -> SegmentIterator<'data, 'file, R>ⓘ

Notable traits for SegmentIterator<'data, 'file, R>

impl<'data, 'file, R: ReadRef<'data>> Iterator for SegmentIterator<'data, 'file, R> type Item = Segment<'data, 'file, R>;
[src]

Get an iterator over the segments in the file.

fn section_by_name(
    &'file self,
    section_name: &str
) -> Option<Section<'data, 'file, R>>[src]

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

fn section_by_index(
    &'file self,
    index: SectionIndex
) -> Result<Section<'data, 'file, R>>[src]

Get the section at the given index. Read more

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

Notable traits for SectionIterator<'data, 'file, R>

impl<'data, 'file, R: ReadRef<'data>> Iterator for SectionIterator<'data, 'file, R> type Item = Section<'data, 'file, R>;
[src]

Get an iterator over the sections in the file.

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

Notable traits for ComdatIterator<'data, 'file, R>

impl<'data, 'file, R: ReadRef<'data>> Iterator for ComdatIterator<'data, 'file, R> type Item = Comdat<'data, 'file, R>;
[src]

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

fn symbol_by_index(
    &'file self,
    index: SymbolIndex
) -> Result<Symbol<'data, 'file, R>>[src]

Get the debugging symbol at the given index. Read more

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

Notable traits for SymbolIterator<'data, 'file, R>

impl<'data, 'file, R: ReadRef<'data>> Iterator for SymbolIterator<'data, 'file, R> type Item = Symbol<'data, 'file, R>;
[src]

Get an iterator over the debugging symbols in the file. Read more

fn symbol_table(&'file self) -> Option<SymbolTable<'data, 'file, R>>[src]

Get the symbol table, if any.

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

Notable traits for SymbolIterator<'data, 'file, R>

impl<'data, 'file, R: ReadRef<'data>> Iterator for SymbolIterator<'data, 'file, R> type Item = Symbol<'data, 'file, R>;
[src]

Get an iterator over the dynamic linking symbols in the file. Read more

fn dynamic_symbol_table(&'file self) -> Option<SymbolTable<'data, 'file, R>>[src]

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

fn dynamic_relocations(
    &'file self
) -> Option<DynamicRelocationIterator<'data, 'file, R>>[src]

Get the dynamic relocations for this file. Read more

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

Construct a map from addresses to symbol names. Read more

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

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

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

Get the imported symbols.

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

Get the exported symbols.

fn has_debug_symbols(&self) -> bool[src]

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

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

The UUID from a Mach-O LC_UUID load command.

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

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.

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

The filename and GUID from the PE CodeView section

fn relative_address_base(&self) -> u64[src]

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

fn entry(&self) -> u64[src]

Get the virtual address of the entry point of the binary

fn flags(&self) -> FileFlags[src]

File flags that are specific to each file format.

fn endianness(&self) -> Endianness[src]

Get the endianness of the file.

Auto Trait Implementations

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

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.