Trait symbolic::debuginfo::DebugSession

source · 
pub trait DebugSession<'session> {
    type Error;
    type FunctionIterator: Iterator<Item = Result<Function<'session>, Self::Error>>;
    type FileIterator: Iterator<Item = Result<FileEntry<'session>, Self::Error>>;

    // Required methods
    fn functions(&'session self) -> Self::FunctionIterator;
    fn files(&'session self) -> Self::FileIterator;
    fn source_by_path(
        &self,
        path: &str
    ) -> Result<Option<SourceFileDescriptor<'_>>, Self::Error>;
}
Expand description

A stateful session for interfacing with debug information.

Debug sessions can be obtained via ObjectLike::debug_session. Since computing a session may be a costly operation, try to reuse the session as much as possible.

Implementing DebugSession

Reading debug information from object files usually requires loading multiple sections into memory and computing maps for quick random access to certain information. Since this can be a quite costly process, this is encapsulated into a DebugSession. The session may hold whatever data and caches may be necessary for efficiently interfacing with the debug info.

All trait methods on a DebugSession receive &mut self, to allow mutation of internal cache structures. Lifetimes of returned types are tied to this session’s lifetime, which allows to borrow data from the session.

Examples for things to compute when building a debug session are:

  • Decompress debug information if it is stored with compression.
  • Build a symbol map for random access to public symbols.
  • Map string tables and other lookup tables.
  • Read headers of compilation units (compilands) to resolve cross-unit references.

Required Associated Types§

source

type Error

The error returned when reading debug information fails.

source

type FunctionIterator: Iterator<Item = Result<Function<'session>, Self::Error>>

An iterator over all functions in this debug file.

source

type FileIterator: Iterator<Item = Result<FileEntry<'session>, Self::Error>>

An iterator over all source files referenced by this debug file.

Required Methods§

source

fn functions(&'session self) -> Self::FunctionIterator

Returns an iterator over all functions in this debug file.

Functions are iterated in the order they are declared in their compilation units. The functions yielded by this iterator include all inlinees and line records resolved.

Note that the iterator holds a mutable borrow on the debug session, which allows it to use caches and optimize resources while resolving function and line information.

source

fn files(&'session self) -> Self::FileIterator

Returns an iterator over all source files referenced by this debug file.

source

fn source_by_path( &self, path: &str ) -> Result<Option<SourceFileDescriptor<'_>>, Self::Error>

Looks up a file’s source by its full canonicalized path.

Returns a descriptor that has all the information available of the source. It can either contain the source contents directly, if it was embedded, or a source link.

Implementors§