[−][src]Trait object::Object

pub trait Object<'data, 'file> {
    type Segment: ObjectSegment<'data>;
    type SegmentIterator: Iterator<Item = Self::Segment>;
    type Section: ObjectSection<'data>;
    type SectionIterator: Iterator<Item = Self::Section>;
    type SymbolIterator: Iterator<Item = (SymbolIndex, Symbol<'data>)>;
    fn machine(&self) -> Machine;

    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
    ) -> Option<Self::Section>;

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

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

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

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

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

    fn is_little_endian(&self) -> bool;

    fn has_debug_symbols(&self) -> bool;

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

    fn symbol_data(&'file self, symbol: &Symbol<'data>) -> Option<&'data [u8]> { ... }

    fn mach_uuid(&self) -> Option<Uuid> { ... }

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

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

An object file.

Associated Types

type Segment: ObjectSegment<'data>

A segment in the object file.

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

An iterator over the segments in the object file.

type Section: ObjectSection<'data>

A section in the object file.

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

An iterator over the sections in the object file.

type SymbolIterator: Iterator<Item = (SymbolIndex, Symbol<'data>)>

An iterator over the symbols in the object file.

Loading content...

Required methods

fn machine(&self) -> Machine

Get the machine type of the file.

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

Get an iterator over the segments in the file.

fn entry(&'file self) -> u64

Get the entry point address of the binary

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 ".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.

fn section_by_index(&'file self, index: SectionIndex) -> Option<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.

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

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.

This is similar to self.symbols().nth(index), except that the index will take into account malformed or unsupported symbols.

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

Get an iterator over the debugging symbols in the file.

This may skip over symbols that are malformed or unsupported.

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

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

This may skip over symbols that are malformed or unsupported.

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

Construct a map from addresses to symbols.

fn is_little_endian(&self) -> bool

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

fn has_debug_symbols(&self) -> bool

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

Loading content...

Provided methods

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

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

The section_name is interpreted according to Self::section_by_name.

This may decompress section data.

fn symbol_data(&'file self, symbol: &Symbol<'data>) -> Option<&'data [u8]>

Get the data for the given symbol.

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.

The filename and CRC from a .gnu_debuglink section.

Loading content...

Implementors

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

type Segment = ElfSegment<'data, 'file>

type SegmentIterator = ElfSegmentIterator<'data, 'file>

type Section = ElfSection<'data, 'file>

type SectionIterator = ElfSectionIterator<'data, 'file>

type SymbolIterator = ElfSymbolIterator<'data, 'file>

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 SymbolIterator = SymbolIterator<'data, 'file>

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

type Segment = MachOSegment<'data, 'file>

type SegmentIterator = MachOSegmentIterator<'data, 'file>

type Section = MachOSection<'data, 'file>

type SectionIterator = MachOSectionIterator<'data, 'file>

type SymbolIterator = MachOSymbolIterator<'data>

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

type Segment = PeSegment<'data, 'file>

type SegmentIterator = PeSegmentIterator<'data, 'file>

type Section = PeSection<'data, 'file>

type SectionIterator = PeSectionIterator<'data, 'file>

type SymbolIterator = PeSymbolIterator<'data, 'file>

impl<'file> Object<'static, 'file> for WasmFile[src]

type Segment = WasmSegment<'file>

type SegmentIterator = WasmSegmentIterator<'file>

type Section = WasmSection<'file>

type SectionIterator = WasmSectionIterator<'file>

type SymbolIterator = WasmSymbolIterator<'file>

Loading content...