Struct gimli::read::DebugLine

pub struct DebugLine<R> { /* fields omitted */ }

The DebugLine struct contains the source location to instruction mapping found in the .debug_line section.

Implementations

impl<'input, Endian> DebugLine<EndianSlice<'input, Endian>> where
    Endian: Endianity, 

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

Construct a new DebugLine instance from the data in the .debug_line section.

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

use gimli::{DebugLine, LittleEndian};

let debug_line = DebugLine::new(read_debug_line_section_somehow(), LittleEndian);

impl<R: Reader> DebugLine<R>

pub fn program(
    &self,
    offset: DebugLineOffset<R::Offset>,
    address_size: u8,
    comp_dir: Option<R>,
    comp_name: Option<R>
) -> Result<IncompleteLineProgram<R>>

Parse the line number program whose header is at the given offset in the .debug_line section.

The address_size must match the compilation unit that the lines apply to. The comp_dir should be from the DW_AT_comp_dir attribute of the compilation unit. The comp_name should be from the DW_AT_name attribute of the compilation unit.

use gimli::{DebugLine, DebugLineOffset, IncompleteLineProgram, EndianSlice, LittleEndian};

let debug_line = DebugLine::new(read_debug_line_section_somehow(), LittleEndian);

// In a real example, we'd grab the offset via a compilation unit
// entry's `DW_AT_stmt_list` attribute, and the address size from that
// unit directly.
let offset = DebugLineOffset(0);
let address_size = 8;

let program = debug_line.program(offset, address_size, None, None)
    .expect("should have found a header at that offset, and parsed it OK");

impl<T> DebugLine<T>

pub fn borrow<'a, F, R>(&'a self, borrow: F) -> DebugLine<R> where
    F: FnMut(&'a T) -> R, 

Create a DebugLine 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::DebugLine<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 DebugLine<R>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for DebugLine<R>

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

Formats the value using the given formatter.

impl<R: Default> Default for DebugLine<R>

fn default() -> DebugLine<R>

Returns the “default value” for a type.

impl<R> From<R> for DebugLine<R>

fn from(debug_line_section: R) -> Self

Performs the conversion.

impl<R> Section<R> for DebugLine<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 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.

fn lookup_offset_id(&self, id: ReaderOffsetId) -> Option<(SectionId, R::Offset)> where
    R: Reader, 

Returns the Reader for this section.

impl<R: Copy> Copy for DebugLine<R>