Struct symbolic_debuginfo::SymbolMap

pub struct SymbolMap<'data> { /* fields omitted */ }

A sorted list of symbols, suitable for quick lookups.

This type can either be computed from a list or iterator of symbols, or preferrably directly by calling ObjectLike::symbol_map on any object. Symbols in the symbol map are guaranteed to have a size set, except for the last symbol, which is computed by taking the offset to the subsequent symbol.

SymbolMap also exposes a read-only view on the sorted slice of symbols. It can be converted to and from lists of symbols.

Example

let map = SymbolMap::from(vec![
    Symbol { name: Some("A".into()), address: 0x4400, size: 0 },
    Symbol { name: Some("B".into()), address: 0x4200, size: 0 },
    Symbol { name: Some("C".into()), address: 0x4000, size: 0 },
]);

assert_eq!(map[0], Symbol {
    name: Some("C".into()),
    address: 0x4000,
    size: 0x200,
});

Methods

impl<'data> SymbolMap<'data>

pub fn new() -> Self

Creates a new, empty symbol map.

pub fn lookup(&self, address: u64) -> Option<&Symbol<'data>>

Looks up a symbol in the symbol map.

pub fn lookup_range<R>(&self, range: R) -> Option<&Symbol<'data>> where
    R: RangeBounds<u64>, 

Looks up a symbol covering an entire range.

This is similar to lookup, but it only returns the symbol result if it also covers the inclusive end address of the range.

Trait Implementations

impl<'d> AsRef<[Symbol<'d>]> for SymbolMap<'d>

fn as_ref(&self) -> &[Symbol<'d>]

Performs the conversion.

impl<'data> IntoIterator for SymbolMap<'data>

type Item = Symbol<'data>

The type of the elements being iterated over.

type IntoIter = SymbolMapIter<'data>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'data, 'a> IntoIterator for &'a SymbolMap<'data>

type Item = &'a Symbol<'data>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Symbol<'data>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'data> Default for SymbolMap<'data>

fn default() -> SymbolMap<'data>

Returns the "default value" for a type.

impl<'d> From<Vec<Symbol<'d>>> for SymbolMap<'d>

fn from(symbols: Vec<Symbol<'d>>) -> Self

Performs the conversion.

impl<'data> Clone for SymbolMap<'data>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data> Debug for SymbolMap<'data>

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

Formats the value using the given formatter.

impl<'d> Deref for SymbolMap<'d>

type Target = [Symbol<'d>]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'d> FromIterator<Symbol<'d>> for SymbolMap<'d>

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = Symbol<'d>>, 

Creates a value from an iterator.