Struct symbolic_symcache::SymCache

pub struct SymCache<'a> { /* fields omitted */ }

An abstraction around a symbolication cache file.

Methods

impl<'a> SymCache<'a>

pub fn new(byteview: ByteView<'a>) -> Result<SymCache<'a>, SymCacheError>

Load a symcache from a byteview.

pub fn from_object(obj: &Object) -> Result<SymCache<'a>, SymCacheError>

Constructs a symcache from an object.

pub fn size(&self) -> usize

The total size of the cache file

pub fn as_bytes(&self) -> &[u8]

Returns a pointer to the internal bytes of the cache file

pub fn to_writer<W: Write>(&self, writer: W) -> Result<(), Error>

Writes the symcache into a new writer.

pub fn arch(&self) -> Result<Arch, SymCacheError>

The architecture of the symbol file.

pub fn id(&self) -> Result<DebugId, SymCacheError>

The id of the cache file.

pub fn data_source(&self) -> Result<DataSource, SymCacheError>

The source of the SymCache.

pub fn has_line_info(&self) -> Result<bool, SymCacheError>

Returns true if line information is included.

pub fn has_file_info(&self) -> Result<bool, SymCacheError>

Returns true if file information is included.

pub fn file_format_version(&self) -> Result<u32, SymCacheError>

The version of the cache file.

Important traits for Functions<'a>

impl<'a> Iterator for Functions<'a> type Item = Result<Function<'a>, SymCacheError>;

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

Returns an iterator over all functions.

pub fn lookup(&'a self, addr: u64) -> Result<Vec<LineInfo<'a>>, SymCacheError>

Given an address this looks up the symbol at that point.

Because of inling information this returns a vector of zero or more symbols. If nothing is found then the return value will be an empty vector.

Trait Implementations

impl<'a> Debug for SymCache<'a>

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

Formats the value using the given formatter.