Trait object::read::Object[−][src]

pub trait Object<'data: 'file, 'file>: Sealed {
    type Segment: ObjectSegment<'data>;
    type SegmentIterator: Iterator<Item = Self::Segment>;
    type Section: ObjectSection<'data>;
    type SectionIterator: Iterator<Item = Self::Section>;
    type Comdat: ObjectComdat<'data>;
    type ComdatIterator: Iterator<Item = Self::Comdat>;
    type Symbol: ObjectSymbol<'data>;
    type SymbolIterator: Iterator<Item = Self::Symbol>;
    type SymbolTable: ObjectSymbolTable<'data, Symbol = Self::Symbol, SymbolIterator = Self::SymbolIterator>;
    type DynamicRelocationIterator: Iterator<Item = (u64, Relocation)>;
    fn architecture(&self) -> Architecture;

    fn is_little_endian(&self) -> bool;

    fn is_64(&self) -> bool;

    fn segments(&'file self) -> Self::SegmentIterator;

    fn entry(&'file self) -> u64;

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

    fn section_by_index(
        &'file self, 
        index: SectionIndex
    ) -> Result<Self::Section>;

    fn sections(&'file self) -> Self::SectionIterator;

    fn comdats(&'file self) -> Self::ComdatIterator;

    fn symbol_table(&'file self) -> Option<Self::SymbolTable>;

    fn symbol_by_index(&'file self, index: SymbolIndex) -> Result<Self::Symbol>;

    fn symbols(&'file self) -> Self::SymbolIterator;

    fn dynamic_symbol_table(&'file self) -> Option<Self::SymbolTable>;

    fn dynamic_symbols(&'file self) -> Self::SymbolIterator;

    fn dynamic_relocations(
        &'file self
    ) -> Option<Self::DynamicRelocationIterator>;

    fn imports(&self) -> Result<Vec<Import<'data>>>;

    fn exports(&self) -> Result<Vec<Export<'data>>>;

    fn has_debug_symbols(&self) -> bool;

    fn flags(&self) -> FileFlags;

    fn endianness(&self) -> Endianness { ... }

    fn symbol_map(&'file self) -> SymbolMap<SymbolMapName<'data>> { ... }

    fn object_map(&'file self) -> ObjectMap<'data> { ... }

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

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

    fn gnu_debuglink(&self) -> Result<Option<(&'data [u8], u32)>> { ... }
}
[−]

An object file.

Associated Types

type Segment: ObjectSegment<'data>[src][−]

A segment in the object file.

type SegmentIterator: Iterator<Item = Self::Segment>[src][−]

An iterator over the segments in the object file.

type Section: ObjectSection<'data>[src][−]

A section in the object file.

type SectionIterator: Iterator<Item = Self::Section>[src][−]

An iterator over the sections in the object file.

type Comdat: ObjectComdat<'data>[src][−]

A COMDAT section group in the object file.

type ComdatIterator: Iterator<Item = Self::Comdat>[src][−]

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

type Symbol: ObjectSymbol<'data>[src][−]

A symbol in the object file.

type SymbolIterator: Iterator<Item = Self::Symbol>[src][−]

An iterator over symbols in the object file.

type SymbolTable: ObjectSymbolTable<'data, Symbol = Self::Symbol, SymbolIterator = Self::SymbolIterator>[src][−]

A symbol table in the object file.

type DynamicRelocationIterator: Iterator<Item = (u64, Relocation)>[src][−]

An iterator over dynamic relocations in the file.

The first field in the item tuple is the address that the relocation applies to.

Required methods

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) -> Self::SegmentIterator[src][−]

Get an iterator over the segments in the file.

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

Get the entry point address of the binary

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

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

If section_name starts with a ‘.’ then it is treated as a system section name, and is compared using the conventions specific to the object file format. This includes:

  • if “.text” is requested for a Mach-O object file, then the actual section name that is searched for is “__text”.
  • if “.debug_info” is requested for an ELF object file, then “.zdebug_info” may be returned (and similarly for other debug sections).

For some object files, multiple segments may contain sections with the same name. In this case, the first matching section will be used.

This method skips over sections with invalid names.

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

Get the section at the given index.

The meaning of the index depends on the object file.

For some object files, this requires iterating through all sections.

Returns an error if the index is invalid.

fn sections(&'file self) -> Self::SectionIterator[src][−]

Get an iterator over the sections in the file.

fn comdats(&'file self) -> Self::ComdatIterator[src][−]

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

fn symbol_table(&'file self) -> Option<Self::SymbolTable>[src][−]

Get the symbol table, if any.

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

Get the debugging symbol at the given index.

The meaning of the index depends on the object file.

Returns an error if the index is invalid.

fn symbols(&'file self) -> Self::SymbolIterator[src][−]

Get an iterator over the debugging symbols in the file.

This may skip over symbols that are malformed or unsupported.

For Mach-O files, this does not include STAB entries.

fn dynamic_symbol_table(&'file self) -> Option<Self::SymbolTable>[src][−]

Get the dynamic linking symbol table, if any.

Only ELF has a separate dynamic linking symbol table.

fn dynamic_symbols(&'file self) -> Self::SymbolIterator[src][−]

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

This may skip over symbols that are malformed or unsupported.

Only ELF has separate dynamic linking symbols. Other file formats will return an empty iterator.

fn dynamic_relocations(&'file self) -> Option<Self::DynamicRelocationIterator>[src][−]

Get the dynamic relocations for this file.

Symbol indices in these relocations refer to the dynamic symbol table.

Only ELF has dynamic relocations.

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 flags(&self) -> FileFlags[src][−]

File flags that are specific to each file format.

Provided methods

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

Get the endianness of the file.

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

Construct a map from addresses to symbol names.

The map will only contain defined text and data symbols. The dynamic symbol table will only be used if there are no debugging symbols.

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

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

This is derived from Mach-O STAB entries.

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.

Implementors

impl<'data, 'file> Object<'data, 'file> for CoffFile<'data> where
    'data: 'file, [src][+]

type Segment = CoffSegment<'data, 'file>

type SegmentIterator = CoffSegmentIterator<'data, 'file>

type Section = CoffSection<'data, 'file>

type SectionIterator = CoffSectionIterator<'data, 'file>

type Comdat = CoffComdat<'data, 'file>

type ComdatIterator = CoffComdatIterator<'data, 'file>

type Symbol = CoffSymbol<'data, 'file>

type SymbolIterator = CoffSymbolIterator<'data, 'file>

type SymbolTable = CoffSymbolTable<'data, 'file>

type DynamicRelocationIterator = NoDynamicRelocationIterator

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

type Segment = Segment<'data, 'file>

type SegmentIterator = SegmentIterator<'data, 'file>

type Section = Section<'data, 'file>

type SectionIterator = SectionIterator<'data, 'file>

type Comdat = Comdat<'data, 'file>

type ComdatIterator = ComdatIterator<'data, 'file>

type Symbol = Symbol<'data, 'file>

type SymbolIterator = SymbolIterator<'data, 'file>

type SymbolTable = SymbolTable<'data, 'file>

type DynamicRelocationIterator = DynamicRelocationIterator<'data, 'file>

impl<'data, 'file, Elf> Object<'data, 'file> for ElfFile<'data, Elf> where
    'data: 'file,
    Elf: FileHeader, [src][+]

type Segment = ElfSegment<'data, 'file, Elf>

type SegmentIterator = ElfSegmentIterator<'data, 'file, Elf>

type Section = ElfSection<'data, 'file, Elf>

type SectionIterator = ElfSectionIterator<'data, 'file, Elf>

type Comdat = ElfComdat<'data, 'file, Elf>

type ComdatIterator = ElfComdatIterator<'data, 'file, Elf>

type Symbol = ElfSymbol<'data, 'file, Elf>

type SymbolIterator = ElfSymbolIterator<'data, 'file, Elf>

type SymbolTable = ElfSymbolTable<'data, 'file, Elf>

type DynamicRelocationIterator = ElfDynamicRelocationIterator<'data, 'file, Elf>

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

Get the imported symbols.

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

Get the exported symbols.

impl<'data, 'file, Mach> Object<'data, 'file> for MachOFile<'data, Mach> where
    'data: 'file,
    Mach: MachHeader, [src][+]

type Segment = MachOSegment<'data, 'file, Mach>

type SegmentIterator = MachOSegmentIterator<'data, 'file, Mach>

type Section = MachOSection<'data, 'file, Mach>

type SectionIterator = MachOSectionIterator<'data, 'file, Mach>

type Comdat = MachOComdat<'data, 'file, Mach>

type ComdatIterator = MachOComdatIterator<'data, 'file, Mach>

type Symbol = MachOSymbol<'data, 'file, Mach>

type SymbolIterator = MachOSymbolIterator<'data, 'file, Mach>

type SymbolTable = MachOSymbolTable<'data, 'file, Mach>

type DynamicRelocationIterator = NoDynamicRelocationIterator

impl<'data, 'file, Pe> Object<'data, 'file> for PeFile<'data, Pe> where
    'data: 'file,
    Pe: ImageNtHeaders, [src][+]

type Segment = PeSegment<'data, 'file, Pe>

type SegmentIterator = PeSegmentIterator<'data, 'file, Pe>

type Section = PeSection<'data, 'file, Pe>

type SectionIterator = PeSectionIterator<'data, 'file, Pe>

type Comdat = PeComdat<'data, 'file, Pe>

type ComdatIterator = PeComdatIterator<'data, 'file, Pe>

type Symbol = CoffSymbol<'data, 'file>

type SymbolIterator = CoffSymbolIterator<'data, 'file>

type SymbolTable = CoffSymbolTable<'data, 'file>

type DynamicRelocationIterator = NoDynamicRelocationIterator