Struct object::read::Symbol

pub struct Symbol<'data, 'file, R = &'data [u8]>
where
    R: ReadRef<'data>,
{
    inner: SymbolInternal<'data, 'file, R>,
}

An symbol in a SymbolTable.

Most functionality is provided by the ObjectSymbol trait implementation.

Fields

inner: SymbolInternal<'data, 'file, R>

Trait Implementations

impl<'data, 'file, R: ReadRef<'data>> Debug for Symbol<'data, 'file, R>

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

Formats the value using the given formatter.

impl<'data, 'file, R: ReadRef<'data>> ObjectSymbol<'data> for Symbol<'data, 'file, R>

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, R: ReadRef<'data>> Sealed for Symbol<'data, 'file, R>