Struct symbolic_symcache::SymCache

pub struct SymCache<'data> { /* private fields */ }

The serialized SymCache binary format.

This can be parsed from a binary buffer via SymCache::parse and lookups on it can be performed via the SymCache::lookup method.

Implementations

impl<'data> SymCache<'data>

pub fn lookup(&self, addr: u64) -> SourceLocations<'data, '_>

Looks up an instruction address in the SymCache, yielding an iterator of SourceLocations representing a hierarchy of inlined function calls.

pub fn functions(&self) -> Functions<'data>

An iterator over the functions in this SymCache.

Only functions with a valid entry pc, i.e., one not equal to u32::MAX, will be returned. Note that functions are not returned ordered by name or entry pc, but in insertion order, which is essentially random.

pub fn files(&self) -> Files<'data>

An iterator over the files in this SymCache.

Note that files are not returned ordered by name or full path, but in insertion order, which is essentially random.

impl<'data> SymCache<'data>

pub fn parse(buf: &'data [u8]) -> Result<Self, Error>

Parse the SymCache binary format into a convenient type that allows safe access and fast lookups.

pub fn version(&self) -> u32

The version of the SymCache file format.

pub fn is_latest(&self) -> bool

Returns true if this symcache’s version is the current version of the format.

pub fn arch(&self) -> Arch

The architecture of the symbol file.

pub fn debug_id(&self) -> DebugId

The debug identifier of the cache file.

Trait Implementations

impl<'slf, 'd: 'slf> AsSelf<'slf> for SymCache<'d>

type Ref = SymCache<'slf>

The Self type with 'slf lifetimes, returned by as_self.

fn as_self(&'slf self) -> &Self::Ref

Returns a reference to self with downcasted lifetime.

impl<'data> Clone for SymCache<'data>

fn clone(&self) -> SymCache<'data>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data> Debug for SymCache<'data>

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

Formats the value using the given formatter.

impl<'data> PartialEq for SymCache<'data>

fn eq(&self, other: &SymCache<'data>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'data> Eq for SymCache<'data>

impl<'data> StructuralEq for SymCache<'data>

impl<'data> StructuralPartialEq for SymCache<'data>