Struct object::read::xcoff::XcoffSymbol

pub struct XcoffSymbol<'data, 'file, Xcoff, R = &'data [u8]>
where
    Xcoff: FileHeader,
    R: ReadRef<'data>,
{
    pub(super) file: &'file XcoffFile<'data, Xcoff, R>,
    pub(super) symbols: &'file SymbolTable<'data, Xcoff, R>,
    pub(super) index: SymbolIndex,
    pub(super) symbol: &'data Xcoff::Symbol,
}

A symbol in an XcoffFile.

Most functionality is provided by the ObjectSymbol trait implementation.

Fields

file: &'file XcoffFile<'data, Xcoff, R>

symbols: &'file SymbolTable<'data, Xcoff, R>

index: SymbolIndex

symbol: &'data Xcoff::Symbol

Implementations

impl<'data, 'file, Xcoff, R> XcoffSymbol<'data, 'file, Xcoff, R>

where Xcoff: FileHeader, R: ReadRef<'data>,

pub fn xcoff_file(&self) -> &'file XcoffFile<'data, Xcoff, R>

Get the XCOFF file containing this symbol.

pub fn xcoff_symbol(&self) -> &'data Xcoff::Symbol

Get the raw XCOFF symbol structure.

Trait Implementations

impl<'data, 'file, Xcoff, R> Clone for XcoffSymbol<'data, 'file, Xcoff, R>

where Xcoff: FileHeader + Clone, R: ReadRef<'data> + Clone, Xcoff::Symbol: Clone,

fn clone(&self) -> XcoffSymbol<'data, 'file, Xcoff, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data, 'file, Xcoff, R> Debug for XcoffSymbol<'data, 'file, Xcoff, R>

where Xcoff: FileHeader + Debug, R: ReadRef<'data> + Debug, Xcoff::Symbol: Debug,

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

Formats the value using the given formatter.

impl<'data, 'file, Xcoff: FileHeader, R: ReadRef<'data>> ObjectSymbol<'data> for XcoffSymbol<'data, 'file, Xcoff, R>

fn is_definition(&self) -> bool

Return true if the symbol is a definition of a function or data object.

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_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, Xcoff, R> Copy for XcoffSymbol<'data, 'file, Xcoff, R>

where Xcoff: FileHeader + Copy, R: ReadRef<'data> + Copy, Xcoff::Symbol: Copy,

impl<'data, 'file, Xcoff: FileHeader, R: ReadRef<'data>> Sealed for XcoffSymbol<'data, 'file, Xcoff, R>