Struct object::read::File

pub struct File<'data> { /* fields omitted */ }

An object file.

Most functionality is provided by the Object trait implementation.

Methods

impl<'data> File<'data>

pub fn parse(data: &'data [u8]) -> Result<Self, &'static str>

Parse the raw file data.

pub fn format(&self) -> BinaryFormat

Return the file format.

Trait Implementations

impl<'data> Debug for File<'data>

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

Formats the value using the given formatter.

impl<'data, 'file> Object<'data, 'file> for File<'data> where
    'data: 'file, 

type Segment = Segment<'data, 'file>

A segment in the object file.

type SegmentIterator = SegmentIterator<'data, 'file>

An iterator over the segments in the object file.

type Section = Section<'data, 'file>

A section in the object file.

type SectionIterator = SectionIterator<'data, 'file>

An iterator over the sections in the object file.

type SymbolIterator = SymbolIterator<'data, 'file>

An iterator over the symbols in the object file.

fn architecture(&self) -> Architecture

Get the architecture type of the file.

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.

Important traits for SegmentIterator<'data, 'file>

impl<'data, 'file> Iterator for SegmentIterator<'data, 'file> type Item = Segment<'data, 'file>;

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

Get an iterator over the segments in the file.

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

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

fn section_by_index(
    &'file self,
    index: SectionIndex
) -> Option<Section<'data, 'file>>

Get the section at the given index.

fn section_data_by_name(&self, section_name: &str) -> Option<Cow<'data, [u8]>>

Get the contents of the section named section_name, if such a section exists.

Important traits for SectionIterator<'data, 'file>

impl<'data, 'file> Iterator for SectionIterator<'data, 'file> type Item = Section<'data, 'file>;

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

Get an iterator over the sections in the file.

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

Get the debugging symbol at the given index.

Important traits for SymbolIterator<'data, 'file>

impl<'data, 'file> Iterator for SymbolIterator<'data, 'file> type Item = (SymbolIndex, Symbol<'data>);

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

Get an iterator over the debugging symbols in the file.

Important traits for SymbolIterator<'data, 'file>

impl<'data, 'file> Iterator for SymbolIterator<'data, 'file> type Item = (SymbolIndex, Symbol<'data>);

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

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

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

Construct a map from addresses to symbols.

fn has_debug_symbols(&self) -> bool

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

fn mach_uuid(&self) -> Option<Uuid>

The UUID from a Mach-O LC_UUID load command.

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

The build ID from an ELF NT_GNU_BUILD_ID note.

fn gnu_debuglink(&self) -> Option<(&'data [u8], u32)>

The filename and CRC from a .gnu_debuglink section.

fn entry(&self) -> u64

Get the entry point address 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 symbol_data(&'file self, symbol: &Symbol<'data>) -> Option<&'data [u8]>

Get the data for the given symbol.