Struct symbolic_debuginfo::sourcebundle::SourceBundle

source · [−]

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

Expand description

A bundle of source code files.

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

Implementations

source

impl<'data> SourceBundle<'data>

source

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

Tests whether the buffer could contain a SourceBundle.

source

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

Tries to parse a SourceBundle from the given slice.

source

pub fn version(&self) -> SourceBundleVersion

Returns the version of this source bundle format.

source

pub fn file_format(&self) -> FileFormat

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

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

Source bundles never have symbols.

source

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

Returns an iterator over symbols in the public symbol table.

source

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

Returns an ordered map of symbols in the symbol table.

source

pub fn has_debug_info(&self) -> bool

Determines whether this object contains debug information.

Source bundles never have debug info.

source

pub fn debug_session(
&self
) -> Result<SourceBundleDebugSession<'data>, 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.

source

pub fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

source

pub fn has_sources(&self) -> bool

Determines whether this object contains embedded source.

source

pub fn is_malformed(&self) -> bool

Determines whether this object is malformed and was only partially parsed

source

pub fn data(&self) -> &'data [u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Returns the raw data of the source bundle.

source

pub fn is_empty(&self) -> bool

Returns true if this source bundle contains no source code.

Trait Implementations

source

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

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

source

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

Formats the value using the given formatter. Read more

source

impl<'data: 'object, 'object> ObjectLike<'data, 'object> for SourceBundle<'data>

type Error = SourceBundleError

Errors thrown when reading information from this object.

type Session = SourceBundleDebugSession<'data>

A session that allows optimized access to debugging information.

type SymbolIterator = SourceBundleSymbolIterator<'data>

The iterator over the symbols in the public symbol table.

source

fn file_format(&self) -> FileFormat

The container format of this file.

source

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

The code identifier of this object. Read more

source

fn debug_id(&self) -> DebugId

The debug information identifier of this object.

source

fn arch(&self) -> Arch

The CPU architecture of this object.

source

fn kind(&self) -> ObjectKind

The kind of this object.

source

fn load_address(&self) -> u64

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

source

fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

source

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

Returns an ordered map of symbols in the symbol table.

source

fn symbols(&self) -> Self::SymbolIterator

Returns an iterator over symbols in the public symbol table.

source

fn has_debug_info(&self) -> bool

Determines whether this object contains debug information.

source

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

Constructs a debugging session. Read more

source

fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

source

fn has_sources(&self) -> bool

Determines whether this object contains embedded sources.

source

fn is_malformed(&self) -> bool

Determines whether this object is malformed and was only partially parsed

Auto Trait Implementations

impl<'data> !RefUnwindSafe for SourceBundle<'data>

impl<'data> Send for SourceBundle<'data>

impl<'data> Sync for SourceBundle<'data>

impl<'data> Unpin for SourceBundle<'data>

impl<'data> !UnwindSafe for SourceBundle<'data>

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T where
Self: Into<T>,

Converts self into T using Into<T>. 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

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

Causes self to use its Binary implementation when Debug-formatted. Read more

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

Causes self to use its Display implementation when Debug-formatted. Read more

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted. Read more

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted. Read more

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

Causes self to use its Octal implementation when Debug-formatted. Read more

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted. Read more

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted. Read more

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted. Read more

fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

impl<T> Pipe for T where
T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
 Self: Borrow,
 B: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut B) -> R
) -> R where
 Self: BorrowMut,
 B: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
 Self: AsRef,
 U: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
 Self: AsMut,
 U: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
 Self: Deref<Target = T>,
 T: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut T) -> R
) -> R where
 Self: DerefMut<Target = T> + Deref,
 T: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

source

impl RecreateContext 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

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow,
B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut,
B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow,
B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut,
B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct symbolic_debuginfo::sourcebundle::SourceBundle

Implementations

impl<'data> SourceBundle<'data>

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

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

pub fn version(&self) -> SourceBundleVersion

pub fn file_format(&self) -> FileFormat

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

pub fn debug_id(&self) -> DebugId

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

pub fn arch(&self) -> Arch

pub fn load_address(&self) -> u64

pub fn has_symbols(&self) -> bool

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

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

pub fn has_debug_info(&self) -> bool

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

pub fn has_unwind_info(&self) -> bool

pub fn has_sources(&self) -> bool

pub fn is_malformed(&self) -> bool

pub fn data(&self) -> &'data [u8]ⓘNotable traits for &'_ mut [u8]impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

pub fn is_empty(&self) -> bool

Trait Implementations

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

type Ref = SourceBundle<'slf>

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

impl Debug for SourceBundle<'_>

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

impl<'data: 'object, 'object> ObjectLike<'data, 'object> for SourceBundle<'data>

type Error = SourceBundleError

type Session = SourceBundleDebugSession<'data>

type SymbolIterator = SourceBundleSymbolIterator<'data>

fn file_format(&self) -> FileFormat

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

fn debug_id(&self) -> DebugId

fn arch(&self) -> Arch

fn kind(&self) -> ObjectKind

fn load_address(&self) -> u64

fn has_symbols(&self) -> bool

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

fn symbols(&self) -> Self::SymbolIterator

fn has_debug_info(&self) -> bool

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

fn has_unwind_info(&self) -> bool

fn has_sources(&self) -> bool

fn is_malformed(&self) -> bool

Auto Trait Implementations

impl<'data> !RefUnwindSafe for SourceBundle<'data>

impl<'data> Send for SourceBundle<'data>

impl<'data> Sync for SourceBundle<'data>

impl<'data> Unpin for SourceBundle<'data>

impl<'data> !UnwindSafe for SourceBundle<'data>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

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

fn extract_context(self, _original_input: I)

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self> where &'a Self: for<'a> IntoIterator,

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pipe for T where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where R: 'a,

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

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

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

pub fn data(&self) -> &'data [u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

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

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

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

fn conv<T>(self) -> T where
Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,

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

impl<T> Pipe for T where
T: ?Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,

fn pipe_deref_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a,

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

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

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