Struct object::read::File

source · [−]

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

Expand description

An object file.

Most functionality is provided by the Object trait implementation.

Implementations

source

impl<'data> File<'data>

source

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

Parse the raw file data.

source

pub fn format(&self) -> BinaryFormat

Return the file format.

Trait Implementations

source

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

source

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

Formats the value using the given formatter. Read more

source

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

A COMDAT section group in the object file.

type ComdatIterator = ComdatIterator<'data, 'file>

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

type Symbol = Symbol<'data, 'file>

A symbol in the object file.

type SymbolIterator = SymbolIterator<'data, 'file>

An iterator over symbols in the object file.

type SymbolTable = SymbolTable<'data, 'file>

A symbol table in the object file.

type DynamicRelocationIterator = DynamicRelocationIterator<'data, 'file>

An iterator over dynamic relocations in the file. Read more

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 segments(&'file self) -> SegmentIterator<'data, 'file>ⓘNotable traits for SegmentIterator<'data, 'file>`impl<'data, 'file> Iterator for SegmentIterator<'data, 'file> type Item = Segment<'data, 'file>;`

Get an iterator over the segments in the file.

source

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

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

source

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

Get the section at the given index. Read more

source

fn sections(&'file self) -> SectionIterator<'data, 'file>ⓘNotable traits for SectionIterator<'data, 'file>`impl<'data, 'file> Iterator for SectionIterator<'data, 'file> type Item = Section<'data, 'file>;`

Get an iterator over the sections in the file.

source

fn comdats(&'file self) -> ComdatIterator<'data, 'file>ⓘNotable traits for ComdatIterator<'data, 'file>`impl<'data, 'file> Iterator for ComdatIterator<'data, 'file> type Item = Comdat<'data, 'file>;`

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

source

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

Get the debugging symbol at the given index. Read more

source

fn symbols(&'file self) -> SymbolIterator<'data, 'file>ⓘNotable traits for SymbolIterator<'data, 'file>`impl<'data, 'file> Iterator for SymbolIterator<'data, 'file> type Item = Symbol<'data, 'file>;`

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

source

fn symbol_table(&'file self) -> Option<SymbolTable<'data, 'file>>

Get the symbol table, if any.

source

fn dynamic_symbols(&'file self) -> SymbolIterator<'data, 'file>ⓘNotable traits for SymbolIterator<'data, 'file>`impl<'data, 'file> Iterator for SymbolIterator<'data, 'file> type Item = Symbol<'data, 'file>;`

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

source

fn dynamic_symbol_table(&'file self) -> Option<SymbolTable<'data, 'file>>

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

source

fn dynamic_relocations(
&'file self
) -> Option<DynamicRelocationIterator<'data, 'file>>

Get the dynamic relocations for this file. Read more

source

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

Construct a map from addresses to symbol names. Read more

source

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

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

source

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

Get the imported symbols.

source

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

Get the exported symbols.

source

fn has_debug_symbols(&self) -> bool

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

source

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

The UUID from a Mach-O LC_UUID load command.

source

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

The build ID from an ELF NT_GNU_BUILD_ID note.

source

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

The filename and CRC from a .gnu_debuglink section.

source

fn entry(&self) -> u64

Get the entry point address of the binary

source

fn flags(&self) -> FileFlags

File flags that are specific to each file format.

source

fn endianness(&self) -> Endianness

Get the endianness of the file.

Auto Trait Implementations

impl<'data> RefUnwindSafe for File<'data>

impl<'data> Send for File<'data>

impl<'data> Sync for File<'data>

impl<'data> Unpin for File<'data>

impl<'data> UnwindSafe for File<'data>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct object::read::File

Implementations

impl<'data> File<'data>

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

pub fn format(&self) -> BinaryFormat

Trait Implementations

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

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

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

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>

fn architecture(&self) -> Architecture

fn is_little_endian(&self) -> bool

fn is_64(&self) -> bool

fn segments(&'file self) -> SegmentIterator<'data, 'file>ⓘNotable traits for SegmentIterator<'data, 'file>impl<'data, 'file> Iterator for SegmentIterator<'data, 'file> type Item = Segment<'data, 'file>;

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

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

fn sections(&'file self) -> SectionIterator<'data, 'file>ⓘNotable traits for SectionIterator<'data, 'file>impl<'data, 'file> Iterator for SectionIterator<'data, 'file> type Item = Section<'data, 'file>;

fn comdats(&'file self) -> ComdatIterator<'data, 'file>ⓘNotable traits for ComdatIterator<'data, 'file>impl<'data, 'file> Iterator for ComdatIterator<'data, 'file> type Item = Comdat<'data, 'file>;

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

fn symbols(&'file self) -> SymbolIterator<'data, 'file>ⓘNotable traits for SymbolIterator<'data, 'file>impl<'data, 'file> Iterator for SymbolIterator<'data, 'file> type Item = Symbol<'data, 'file>;

fn symbol_table(&'file self) -> Option<SymbolTable<'data, 'file>>

fn dynamic_symbols(&'file self) -> SymbolIterator<'data, 'file>ⓘNotable traits for SymbolIterator<'data, 'file>impl<'data, 'file> Iterator for SymbolIterator<'data, 'file> type Item = Symbol<'data, 'file>;

fn dynamic_symbol_table(&'file self) -> Option<SymbolTable<'data, 'file>>

fn dynamic_relocations( &'file self) -> Option<DynamicRelocationIterator<'data, 'file>>

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

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

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

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

fn has_debug_symbols(&self) -> bool

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 entry(&self) -> u64

fn flags(&self) -> FileFlags

fn endianness(&self) -> Endianness

Auto Trait Implementations

impl<'data> RefUnwindSafe for File<'data>

impl<'data> Send for File<'data>

impl<'data> Sync for File<'data>

impl<'data> Unpin for File<'data>

impl<'data> UnwindSafe for File<'data>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

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

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

fn segments(&'file self) -> SegmentIterator<'data, 'file>ⓘNotable traits for SegmentIterator<'data, 'file>`impl<'data, 'file> Iterator for SegmentIterator<'data, 'file> type Item = Segment<'data, 'file>;`

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

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

fn sections(&'file self) -> SectionIterator<'data, 'file>ⓘNotable traits for SectionIterator<'data, 'file>`impl<'data, 'file> Iterator for SectionIterator<'data, 'file> type Item = Section<'data, 'file>;`

fn comdats(&'file self) -> ComdatIterator<'data, 'file>ⓘNotable traits for ComdatIterator<'data, 'file>`impl<'data, 'file> Iterator for ComdatIterator<'data, 'file> type Item = Comdat<'data, 'file>;`

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

fn symbols(&'file self) -> SymbolIterator<'data, 'file>ⓘNotable traits for SymbolIterator<'data, 'file>`impl<'data, 'file> Iterator for SymbolIterator<'data, 'file> type Item = Symbol<'data, 'file>;`

fn dynamic_symbols(&'file self) -> SymbolIterator<'data, 'file>ⓘNotable traits for SymbolIterator<'data, 'file>`impl<'data, 'file> Iterator for SymbolIterator<'data, 'file> type Item = Symbol<'data, 'file>;`

fn dynamic_relocations(
&'file self
) -> Option<DynamicRelocationIterator<'data, 'file>>

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

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,