Struct symbolic_debuginfo::sourcebundle::SourceBundle

pub struct SourceBundle<'d> { /* fields omitted */ }

A bundle of source code files.

To create a source bundle, see SourceBundleWriter. For more information, see the module level documentation.

Methods

impl<'d> SourceBundle<'d>

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

Tests whether the buffer could contain a SourceBundle.

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

Tries to parse a SourceBundle from the given slice.

pub fn version(&self) -> SourceBundleVersion

Returns the version of this source bundle format.

pub fn file_format(&self) -> FileFormat

The container file format, which is always FileFormat::SourceBundle.

pub fn code_id(&self) -> Option<CodeId>

The code identifier of this object.

This is only set if the source bundle was created from an ObjectLike. It can also be set in the SourceBundleWriter by setting the "code_id" attribute.

pub fn debug_id(&self) -> DebugId

The code identifier of this object.

This is only set if the source bundle was created from an ObjectLike. It can also be set in the SourceBundleWriter by setting the "debug_id" attribute.

pub fn name(&self) -> Option<&str>

The debug file name of this object.

This is only set if the source bundle was created from an ObjectLike. It can also be set in the SourceBundleWriter by setting the "object_name" attribute.

pub fn arch(&self) -> Arch

The CPU architecture of this object.

This is only set if the source bundle was created from an ObjectLike. It can also be set in the SourceBundleWriter by setting the "arch" attribute.

pub fn load_address(&self) -> u64

The address at which the image prefers to be loaded into memory.

Because source bundles do not contain this information is always 0.

pub fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

Source bundles never have symbols.

pub fn symbols(&self) -> SourceBundleSymbolIterator<'d>

Returns an iterator over symbols in the public symbol table.

pub fn symbol_map(&self) -> SymbolMap<'d>

Returns an ordered map of symbols in the symbol table.

pub fn has_debug_info(&self) -> bool

Determines whether this object contains debug information.

Source bundles never have debug info.

pub fn debug_session(
    &self
) -> Result<SourceBundleDebugSession<'d>, SourceBundleError>

Constructs a debugging session.

A debugging session loads certain information from the object file and creates caches for efficient access to various records in the debug information. Since this can be quite a costly process, try to reuse the debugging session as long as possible.

pub fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

pub fn has_sources(&self) -> bool

Determines whether this object contains embedded source.

pub fn data(&self) -> &'d [u8]

Returns the raw data of the source bundle.

pub fn is_empty(&self) -> bool

Returns true if this source bundle contains no source code.

Trait Implementations

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

type Ref = SourceBundle<'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<'_> Debug for SourceBundle<'_>

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

Formats the value using the given formatter.

impl<'d> ObjectLike for SourceBundle<'d>

type Error = SourceBundleError

Errors thrown when reading information from this object.

type Session = SourceBundleDebugSession<'d>

A session that allows optimized access to debugging information.

fn file_format(&self) -> FileFormat

The container format of this file.

fn code_id(&self) -> Option<CodeId>

The code identifier of this object.

fn debug_id(&self) -> DebugId

The debug information identifier of this object.

fn arch(&self) -> Arch

The CPU architecture of this object.

fn kind(&self) -> ObjectKind

The kind of this object.

fn load_address(&self) -> u64

The address at which the image prefers to be loaded into memory.

fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

fn symbol_map(&self) -> SymbolMap

Returns an ordered map of symbols in the symbol table.

fn symbols(&self) -> DynIterator<Symbol>

Returns an iterator over symbols in the public symbol table.

fn has_debug_info(&self) -> bool

Determines whether this object contains debug information.

fn debug_session(&self) -> Result<Self::Session, Self::Error>

Constructs a debugging session.

fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

fn has_sources(&self) -> bool

Determines whether this object contains embedded sources.