Struct gimli::read::LocationLists

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

The DWARF data found in .debug_loc and .debug_loclists sections.

Implementations

impl<R> LocationLists<R>

pub fn new(
    debug_loc: DebugLoc<R>,
    debug_loclists: DebugLocLists<R>
) -> LocationLists<R>

Construct a new LocationLists instance from the data in the .debug_loc and .debug_loclists sections.

impl<T> LocationLists<T>

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

Create a LocationLists 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::LocationLists<Vec<u8>> = load_section();
// Create a reference to the DWARF section.
let section = owned_section.borrow(|section| {
    gimli::EndianSlice::new(&section, gimli::LittleEndian)
});

impl<R: Reader> LocationLists<R>

pub fn locations(
    &self,
    offset: LocationListsOffset<R::Offset>,
    unit_encoding: Encoding,
    base_address: u64,
    debug_addr: &DebugAddr<R>,
    debug_addr_base: DebugAddrBase<R::Offset>
) -> Result<LocListIter<R>>

Iterate over the LocationListEntrys starting at the given offset.

The unit_encoding must match the compilation unit that the offset was contained in.

The base_address should be obtained from the DW_AT_low_pc attribute in the DW_TAG_compile_unit entry for the compilation unit that contains this location list.

Can be used with FallibleIterator.

pub fn locations_dwo(
    &self,
    offset: LocationListsOffset<R::Offset>,
    unit_encoding: Encoding,
    base_address: u64,
    debug_addr: &DebugAddr<R>,
    debug_addr_base: DebugAddrBase<R::Offset>
) -> Result<LocListIter<R>>

Similar to locations, but with special handling for .dwo files. This should only been used when this LocationLists was loaded from a .dwo file.

pub fn raw_locations(
    &self,
    offset: LocationListsOffset<R::Offset>,
    unit_encoding: Encoding
) -> Result<RawLocListIter<R>>

Iterate over the raw LocationListEntrys starting at the given offset.

The unit_encoding must match the compilation unit that the offset was contained in.

This iterator does not perform any processing of the location entries, such as handling base addresses.

Can be used with FallibleIterator.

pub fn raw_locations_dwo(
    &self,
    offset: LocationListsOffset<R::Offset>,
    unit_encoding: Encoding
) -> Result<RawLocListIter<R>>

Similar to raw_locations, but with special handling for .dwo files. This should only been used when this LocationLists was loaded from a .dwo file.

pub fn get_offset(
    &self,
    unit_encoding: Encoding,
    base: DebugLocListsBase<R::Offset>,
    index: DebugLocListsIndex<R::Offset>
) -> Result<LocationListsOffset<R::Offset>>

Returns the .debug_loclists offset at the given base and index.

The base must be the DW_AT_loclists_base value from the compilation unit DIE. This is an offset that points to the first entry following the header.

The index is the value of a DW_FORM_loclistx attribute.

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

Call Reader::lookup_offset_id for each section, and return the first match.

Trait Implementations

impl<R: Clone> Clone for LocationLists<R>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for LocationLists<R>

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

Formats the value using the given formatter.

impl<R: Default> Default for LocationLists<R>

fn default() -> LocationLists<R>

Returns the “default value” for a type.

impl<R: Copy> Copy for LocationLists<R>