Struct symbolic::debuginfo::dwarf::gimli::read::DebugStr

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

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
) -> DebugStr<EndianSlice<'input, Endian>>

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> DebugStr<R> where
    R: Reader, 

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

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 for DebugStr<R> where
    R: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R> Copy for DebugStr<R> where
    R: Copy, 

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

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

Formats the value using the given formatter.

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

pub fn default() -> DebugStr<R>

Returns the "default value" for a type.

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

pub fn from(debug_str_section: R) -> DebugStr<R>

Performs the conversion.

impl<R> Section<R> for DebugStr<R>

pub fn id() -> SectionId

Returns the section id for this type.

pub fn reader(&self) -> &R

Returns the Reader for this section.

pub fn section_name() -> &'static str

Returns the ELF section name for this type.

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

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

pub 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.

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

Returns the Reader for this section.