Struct object::read::xcoff::symbol::SymbolTable

pub struct SymbolTable<'data, Xcoff, R = &'data [u8]>
where
    Xcoff: FileHeader,
    R: ReadRef<'data>,
{
    symbols: &'data [SymbolBytes],
    strings: StringTable<'data, R>,
    header: PhantomData<Xcoff>,
}

A table of symbol entries in an XCOFF file.

Also includes the string table used for the symbol names.

Returned by FileHeader::symbols.

Fields

symbols: &'data [SymbolBytes]

strings: StringTable<'data, R>

header: PhantomData<Xcoff>

Implementations

impl<'data, Xcoff, R> SymbolTable<'data, Xcoff, R>

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

pub fn parse(header: Xcoff, data: R) -> Result<Self>

Parse the symbol table.

pub fn strings(&self) -> StringTable<'data, R>

Return the string table used for the symbol names.

pub fn iter<'table>(&'table self) -> SymbolIterator<'data, 'table, Xcoff, R>

Iterate over the symbols.

This does not return null symbols.

pub(super) fn iter_none<'table>( &'table self, ) -> SymbolIterator<'data, 'table, Xcoff, R>

Empty symbol iterator.

pub fn get<T: Pod>(&self, index: SymbolIndex, offset: usize) -> Result<&'data T>

Return the symbol entry at the given index and offset.

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

Get the symbol at the given index.

This does not check if the symbol is null, but does check if the index is in bounds.

pub fn symbol(&self, index: SymbolIndex) -> Result<&'data Xcoff::Symbol>

Get the symbol at the given index.

Returns an error for null symbols and out of bounds indices. Note that this is unable to check whether the index is an auxiliary symbol.

pub fn aux_file( &self, index: SymbolIndex, offset: usize, ) -> Result<&'data Xcoff::FileAux>

Return a file auxiliary symbol.

pub fn aux_csect( &self, index: SymbolIndex, offset: usize, ) -> Result<&'data Xcoff::CsectAux>

Return the csect auxiliary symbol.

pub fn is_empty(&self) -> bool

Return true if the symbol table is empty.

pub fn len(&self) -> usize

The number of symbol table entries.

This includes auxiliary symbol table entries.

Trait Implementations

impl<'data, Xcoff, R> Debug for SymbolTable<'data, Xcoff, R>

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

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

Formats the value using the given formatter.

impl<'data, Xcoff, R> Default for SymbolTable<'data, Xcoff, R>

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

fn default() -> Self

Returns the “default value” for a type.