Trait object::read::traits::Object

source ·

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)>;

Show 33 methods    // Required methods
    fn architecture(&self) -> Architecture;
    fn is_little_endian(&self) -> bool;
    fn is_64(&self) -> bool;
    fn kind(&self) -> ObjectKind;
    fn segments(&'file self) -> Self::SegmentIterator;
    fn section_by_name_bytes(
        &'file self,
        section_name: &[u8]
    ) -> 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 relative_address_base(&'file self) -> u64;
    fn entry(&'file self) -> u64;
    fn flags(&self) -> FileFlags;

    // Provided methods
    fn sub_architecture(&self) -> Option<SubArchitecture> { ... }
    fn endianness(&self) -> Endianness { ... }
    fn section_by_name(&'file self, section_name: &str) -> Option<Self::Section> { ... }
    fn symbol_by_name(&'file self, symbol_name: &str) -> Option<Self::Symbol> { ... }
    fn symbol_by_name_bytes(
        &'file self,
        symbol_name: &[u8]
    ) -> Option<Self::Symbol> { ... }
    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)>> { ... }
    fn gnu_debugaltlink(&self) -> Result<Option<(&'data [u8], &'data [u8])>> { ... }
    fn pdb_info(&self) -> Result<Option<CodeView<'_>>> { ... }
}

Expand description

An object file.

This is the primary trait for the unified read API.

Required Associated Types§

source

type Segment: ObjectSegment<'data>

A loadable segment in the object file.

source

type SegmentIterator: Iterator<Item = Self::Segment>

An iterator for the loadable segments in the object file.

source

type Section: ObjectSection<'data>

A section in the object file.

source

type SectionIterator: Iterator<Item = Self::Section>

An iterator for the sections in the object file.

source

type Comdat: ObjectComdat<'data>

A COMDAT section group in the object file.

source

type ComdatIterator: Iterator<Item = Self::Comdat>

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

source

type Symbol: ObjectSymbol<'data>

A symbol in the object file.

source

type SymbolIterator: Iterator<Item = Self::Symbol>

An iterator for symbols in the object file.

source

type SymbolTable: ObjectSymbolTable<'data, Symbol = Self::Symbol, SymbolIterator = Self::SymbolIterator>

A symbol table in the object file.

source

type DynamicRelocationIterator: Iterator<Item = (u64, Relocation)>

An iterator for the dynamic relocations in the file.

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

Required Methods§

source

fn architecture(&self) -> Architecture

Get the architecture type of the file.

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(&'file self) -> Self::SegmentIterator

Get an iterator for the loadable segments in the file.

For ELF, this is program headers with type PT_LOAD. For Mach-O, this is load commands with type LC_SEGMENT or LC_SEGMENT_64. For PE, this is all sections.

source

fn section_by_name_bytes( &'file self, section_name: &[u8] ) -> Option<Self::Section>

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

source

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

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.

source

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

Get an iterator for the sections in the file.

source

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

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

source

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

Get the debugging symbol table, if any.

source

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

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.

source

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

Get an iterator for 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.

source

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

Get the dynamic linking symbol table, if any.

Only ELF has a separate dynamic linking symbol table. Consider using Self::exports or Self::imports instead.

source

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

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

This may skip over symbols that are malformed or unsupported.

Only ELF has dynamic linking symbols. Other file formats will return an empty iterator. Consider using Self::exports or Self::imports instead.

source

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

Get the dynamic relocations for this file.

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

Only ELF has dynamic relocations.

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.

Some file formats may provide other kinds of symbols that can be retrieved using the low level API.

source

fn has_debug_symbols(&self) -> bool

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

source

fn relative_address_base(&'file self) -> u64

Get the base address used for relative virtual addresses.

Currently this is only non-zero for PE.

source

fn entry(&'file 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.

Provided Methods§

source

fn sub_architecture(&self) -> Option<SubArchitecture>

Get the sub-architecture type of the file if known.

A value of None has a range of meanings: the file supports all sub-architectures, the file does not explicitly specify a sub-architecture, or the sub-architecture is currently unrecognized.

source

fn endianness(&self) -> Endianness

Get the endianness of the file.

source

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

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 “.debug_str_offsets” is requested for a Mach-O object file, then the actual section name that is searched for is “__debug_str_offs”.
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.

source