Struct gimli::read::DebugInfo

pub struct DebugInfo<R> { /* private fields */ }

The DebugInfo struct represents the DWARF debugging information found in the .debug_info section.

Implementations

impl<'input, Endian> DebugInfo<EndianSlice<'input, Endian>>

where Endian: Endianity,

pub fn new(debug_info_section: &'input [u8], endian: Endian) -> Self

Construct a new DebugInfo instance from the data in the .debug_info section.

It is the caller’s responsibility to read the .debug_info section and present it as a &[u8] slice. That means using some ELF loader on Linux, a Mach-O loader on macOS, etc.

use gimli::{DebugInfo, LittleEndian};

let debug_info = DebugInfo::new(read_debug_info_section_somehow(), LittleEndian);

impl<R: Reader> DebugInfo<R>

pub fn units(&self) -> DebugInfoUnitHeadersIter<R>

Iterate the units in this .debug_info section.

use gimli::{DebugInfo, LittleEndian};

let debug_info = DebugInfo::new(read_debug_info_section_somehow(), LittleEndian);

let mut iter = debug_info.units();
while let Some(unit) = iter.next().unwrap() {
    println!("unit's length is {}", unit.unit_length());
}

Can be used with FallibleIterator.

pub fn header_from_offset( &self, offset: DebugInfoOffset<R::Offset> ) -> Result<UnitHeader<R>>

Get the UnitHeader located at offset from this .debug_info section.

impl<T> DebugInfo<T>

pub fn borrow<'a, F, R>(&'a self, borrow: F) -> DebugInfo<R>

where F: FnMut(&'a T) -> R,

Create a DebugInfo section that references the data in self.

This is useful when R implements Reader but T does not.

Example Usage

// Read the DWARF section into a `Vec` with whatever object loader you're using.
let owned_section: gimli::DebugInfo<Vec<u8>> = load_section();
// Create a reference to the DWARF section.
let section = owned_section.borrow(|section| {
    gimli::EndianSlice::new(&section, gimli::LittleEndian)
});

Trait Implementations

impl<R: Clone> Clone for DebugInfo<R>

fn clone(&self) -> DebugInfo<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for DebugInfo<R>

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

Formats the value using the given formatter.

impl<R: Default> Default for DebugInfo<R>

fn default() -> DebugInfo<R>

Returns the “default value” for a type.

impl<R> From<R> for DebugInfo<R>

fn from(debug_info_section: R) -> Self

Converts to this type from the input type.

impl<R> Section<R> for DebugInfo<R>

fn id() -> SectionId

Returns the section id for this type.

fn reader(&self) -> &R

Returns the Reader for this section.

fn section_name() -> &'static str

Returns the ELF section name for this type.

fn dwo_section_name() -> Option<&'static str>

Returns the ELF section name (if any) for this type when used in a dwo file.

fn xcoff_section_name() -> Option<&'static str>

Returns the XCOFF section name (if any) for this type when used in a XCOFF file.

fn load<F, E>(f: F) -> Result<Self, E>

where F: FnOnce(SectionId) -> Result<R, E>,

Try to load the section using the given loader function.

impl<R: Copy> Copy for DebugInfo<R>