Struct gimli::read::DebugLine

source ·
pub struct DebugLine<R> { /* private fields */ }
Expand description

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

Implementations§

source§

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

source

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 macOS, etc.

use gimli::{DebugLine, LittleEndian};

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

impl<R: Reader> DebugLine<R>

source

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");
source§

impl<T> DebugLine<T>

source

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§

source§

impl<R: Clone> Clone for DebugLine<R>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> DebugLine<R>

Returns the “default value” for a type. Read more
source§

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

source§

fn from(debug_line_section: R) -> Self

Converts to this type from the input type.
source§

impl<R> Section<R> for DebugLine<R>

source§

fn id() -> SectionId

Returns the section id for this type.
source§

fn reader(&self) -> &R

Returns the Reader for this section.
source§

fn section_name() -> &'static str

Returns the ELF section name for this type.
source§

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

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

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

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

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.
source§

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

Auto Trait Implementations§

§

impl<R> RefUnwindSafe for DebugLine<R>
where R: RefUnwindSafe,

§

impl<R> Send for DebugLine<R>
where R: Send,

§

impl<R> Sync for DebugLine<R>
where R: Sync,

§

impl<R> Unpin for DebugLine<R>
where R: Unpin,

§

impl<R> UnwindSafe for DebugLine<R>
where R: UnwindSafe,

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.