pub struct BcSymbolMap<'d> { /* private fields */ }
Expand description

An in-memory representation of the Apple bitcode symbol map.

This is an auxiliary file, not an object file. It can be used to provide de-obfuscated symbol names to a MachObject object using its load_symbolmap method.

It is common for bitcode builds to obfuscate the names in the object file’s symbol table so that even the DWARF files do not have the actual symbol names. In this case the build process will create a .bcsymbolmap file which maps the obfuscated symbol names back to the original ones. This structure can parse these files and allows providing this information to the MachObject so that it has the original symbol names instead of __hidden#NNN_ ones.

See MachObject::load_symbolmap for an example of how to use this.

Implementations§

source§

impl<'d> BcSymbolMap<'d>

source

pub fn test(bytes: &[u8]) -> bool

Tests whether the buffer could contain a BcSymbolMap.

source

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

Parses the BCSymbolMap.

A symbol map does not contain the UUID of its symbols, instead this is normally encoded in the filename.

source

pub fn get(&self, index: usize) -> Option<&'d str>

Returns the name of a symbol if it exists in this mapping.

Examples
use symbolic_debuginfo::macho::BcSymbolMap;

// let data = std::fs::read("c8374b6d-6e96-34d8-ae38-efaa5fec424f.bcsymbolmap").unwrap();
let map = BcSymbolMap::parse(&data).unwrap();

assert_eq!(map.get(43), Some("Sources/Sentry/Public/SentryMessage.h"));
assert_eq!(map.get(usize::MAX), None);  // We do not have this many entries
source

pub fn resolve(&self, name: &'d str) -> &'d str

Resolves a name using this mapping.

If the name matches the __hidden#NNN_ pattern that indicates a BcSymbolMap lookup it will be looked up the resolved name will be returned. Otherwise the name is returned unchanged.

Examples
use symbolic_debuginfo::macho::BcSymbolMap;

// let data = std::fs::read("c8374b6d-6e96-34d8-ae38-efaa5fec424f.bcsymbolmap").unwrap();
let map = BcSymbolMap::parse(&data).unwrap();

assert_eq!(map.resolve("__hidden#43_"), "Sources/Sentry/Public/SentryMessage.h");
assert_eq!(map.resolve("_addJSONData"), "_addJSONData");  // #64
source

pub fn iter(&self) -> BcSymbolMapIterator<'_, 'd>

Returns an iterator over all the names in this bitcode symbol map.

Trait Implementations§

source§

impl<'slf> AsSelf<'slf> for BcSymbolMap<'_>

§

type Ref = BcSymbolMap<'slf>

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

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

Returns a reference to self with downcasted lifetime.
source§

impl<'d> Clone for BcSymbolMap<'d>

source§

fn clone(&self) -> BcSymbolMap<'d>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'d> Debug for BcSymbolMap<'d>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'d> RefUnwindSafe for BcSymbolMap<'d>

§

impl<'d> Send for BcSymbolMap<'d>

§

impl<'d> Sync for BcSymbolMap<'d>

§

impl<'d> Unpin for BcSymbolMap<'d>

§

impl<'d> UnwindSafe for BcSymbolMap<'d>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<I, T> ExtractContext<I, ()> for T

source§

fn extract_context(self, _original_input: I)

Given the context attached to a nom error, and given the original input to the nom parser, extract more the useful context information. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<I> RecreateContext<I> for I

source§

fn recreate_context(_original_input: I, tail: I) -> I

Given the original input, as well as the context reported by nom, recreate a context in the original string where the error occurred. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.