Struct DebugStr

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

The DebugStr struct represents the DWARF strings found in the .debug_str section.

Implementations

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

where Endian: Endianity,

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

Construct a new DebugStr instance from the data in the .debug_str section.

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

let debug_str = DebugStr::new(read_debug_str_section_somehow(), LittleEndian);

impl<R: Reader> DebugStr<R>

pub fn get_str(&self, offset: DebugStrOffset<R::Offset>) -> Result<R>

Lookup a string from the .debug_str section by DebugStrOffset.

use gimli::{DebugStr, DebugStrOffset, LittleEndian};

let debug_str = DebugStr::new(read_debug_str_section_somehow(), LittleEndian);
println!("Found string {:?}", debug_str.get_str(debug_str_offset_somehow()));

impl<T> DebugStr<T>

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

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for DebugStr<R>

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

Formats the value using the given formatter.

impl<R: Default> Default for DebugStr<R>

fn default() -> DebugStr<R>

Returns the “default value” for a type.

impl<R> From<R> for DebugStr<R>

fn from(debug_str_section: R) -> Self

Converts to this type from the input type.

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