Struct DebugMacro

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

The raw contents of the .debug_macro section.

Implementations

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

where Endian: Endianity,

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

Construct a new DebugMacro instance from the data in the .debug_macro section.

It is the caller’s responsibility to read the .debug_macro 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::{DebugMacro, LittleEndian};

let debug_str = DebugMacro::new(read_section_somehow(), LittleEndian);

impl<R: Reader> DebugMacro<R>

pub fn get_macros( &self, offset: DebugMacroOffset<R::Offset>, ) -> Result<MacroIter<R>>

Look up a macro reference the .debug_macinfo section by DebugMacroOffset.

A macinfo offset points to a list of macro information entries in the .debug_macinfo section. To handle this, the function returns an iterator.

use gimli::{DebugMacro, DebugMacroOffset, LittleEndian};

let debug_macro = DebugMacro::new(read_section_somehow(), LittleEndian);
let mut iter = debug_macro.get_macros(debug_macro_offset_somehow())?;
while let Some(cur_macro) = iter.next()? {
    println!("Found macro info {:?}", cur_macro);
}

impl<T> DebugMacro<T>

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

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

Create a DebugMacro section that references the data in self.

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

Used by DwarfSections::borrow.

Trait Implementations

impl<R: Clone> Clone for DebugMacro<R>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for DebugMacro<R>

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

Formats the value using the given formatter.

impl<R: Default> Default for DebugMacro<R>

fn default() -> DebugMacro<R>

Returns the “default value” for a type.

impl<R> From<R> for DebugMacro<R>

fn from(macro_section: R) -> Self

Converts to this type from the input type.

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

fn dwp_range(&self, offset: u32, size: u32) -> Result<Self>

where R: Reader,

Returns the subrange of the section that is the contribution of a unit in a .dwp file.

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 DebugMacro<R>