Struct object::read::coff::CoffSymbol

pub struct CoffSymbol<'data, 'file, R = &'data [u8], Coff = ImageFileHeader>
where
    R: ReadRef<'data>,
    Coff: CoffHeader,
{
    pub(crate) file: &'file CoffCommon<'data, R, Coff>,
    pub(crate) index: SymbolIndex,
    pub(crate) symbol: &'data Coff::ImageSymbol,
}

A symbol in a CoffFile or PeFile.

Most functionality is provided by the ObjectSymbol trait implementation.

Fields

file: &'file CoffCommon<'data, R, Coff>

index: SymbolIndex

symbol: &'data Coff::ImageSymbol

Implementations

impl<'data, 'file, R: ReadRef<'data>, Coff: CoffHeader> CoffSymbol<'data, 'file, R, Coff>

pub fn raw_symbol(&self) -> &'data Coff::ImageSymbol

Get the raw ImageSymbol struct.

Trait Implementations

impl<'data, 'file, R, Coff> Clone for CoffSymbol<'data, 'file, R, Coff>

where R: ReadRef<'data> + Clone, Coff: CoffHeader + Clone, Coff::ImageSymbol: Clone,

fn clone(&self) -> CoffSymbol<'data, 'file, R, Coff>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data, 'file, R, Coff> Debug for CoffSymbol<'data, 'file, R, Coff>

where R: ReadRef<'data> + Debug, Coff: CoffHeader + Debug, Coff::ImageSymbol: Debug,

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

Formats the value using the given formatter.

impl<'data, 'file, R: ReadRef<'data>, Coff: CoffHeader> ObjectSymbol<'data> for CoffSymbol<'data, 'file, R, Coff>

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, Coff> Copy for CoffSymbol<'data, 'file, R, Coff>

where R: ReadRef<'data> + Copy, Coff: CoffHeader + Copy, Coff::ImageSymbol: Copy,

impl<'data, 'file, R: ReadRef<'data>, Coff: CoffHeader> Sealed for CoffSymbol<'data, 'file, R, Coff>