Struct object::read::macho::symbol::MachOSymbol

pub struct MachOSymbol<'data, 'file, Mach, R = &'data [u8]>
where
    Mach: MachHeader,
    R: ReadRef<'data>,
{
    file: &'file MachOFile<'data, Mach, R>,
    index: SymbolIndex,
    nlist: &'data Mach::Nlist,
}

A symbol in a MachOFile.

Most functionality is provided by the ObjectSymbol trait implementation.

Fields

file: &'file MachOFile<'data, Mach, R>

index: SymbolIndex

nlist: &'data Mach::Nlist

Implementations

impl<'data, 'file, Mach, R> MachOSymbol<'data, 'file, Mach, R>

where Mach: MachHeader, R: ReadRef<'data>,

pub(super) fn new( file: &'file MachOFile<'data, Mach, R>, index: SymbolIndex, nlist: &'data Mach::Nlist, ) -> Option<Self>

pub fn macho_file(&self) -> &'file MachOFile<'data, Mach, R>

Get the Mach-O file containing this symbol.

pub fn macho_symbol(&self) -> &'data Mach::Nlist

Get the raw Mach-O symbol structure.

Trait Implementations

impl<'data, 'file, Mach, R> Clone for MachOSymbol<'data, 'file, Mach, R>

where Mach: MachHeader + Clone, R: ReadRef<'data> + Clone, Mach::Nlist: Clone,

fn clone(&self) -> MachOSymbol<'data, 'file, Mach, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'data, 'file, Mach, R> Debug for MachOSymbol<'data, 'file, Mach, R>

where Mach: MachHeader + Debug, R: ReadRef<'data> + Debug, Mach::Nlist: Debug,

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

Formats the value using the given formatter.

impl<'data, 'file, Mach, R> ObjectSymbol<'data> for MachOSymbol<'data, 'file, Mach, R>

where Mach: MachHeader, R: ReadRef<'data>,

fn index(&self) -> SymbolIndex

The index of the symbol.

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

The name of the symbol.

fn name(&self) -> Result<&'data str>

The name of the symbol.

fn address(&self) -> u64

The address of the symbol. May be zero if the address is unknown.

fn size(&self) -> u64

The size of the symbol. May be zero if the size is unknown.

fn kind(&self) -> SymbolKind

Return the kind of this symbol.

fn section(&self) -> SymbolSection

Returns the section where the symbol is defined.

fn is_undefined(&self) -> bool

Return true if the symbol is undefined.

fn is_definition(&self) -> bool

Return true if the symbol is a definition of a function or data object that has a known address.

fn is_common(&self) -> bool

Return true if the symbol is common data.

fn is_weak(&self) -> bool

Return true if the symbol is weak.

fn scope(&self) -> SymbolScope

Returns the symbol scope.

fn is_global(&self) -> bool

Return true if the symbol visible outside of the compilation unit.

fn is_local(&self) -> bool

Return true if the symbol is only visible within the compilation unit.

fn flags(&self) -> SymbolFlags<SectionIndex, SymbolIndex>

Symbol flags that are specific to each file format.

fn section_index(&self) -> Option<SectionIndex>

Returns the section index for the section containing this symbol.

impl<'data, 'file, Mach, R> Copy for MachOSymbol<'data, 'file, Mach, R>

where Mach: MachHeader + Copy, R: ReadRef<'data> + Copy, Mach::Nlist: Copy,

impl<'data, 'file, Mach, R> Sealed for MachOSymbol<'data, 'file, Mach, R>

where Mach: MachHeader, R: ReadRef<'data>,