Struct UnitHeader 

pub struct UnitHeader<R, Offset = <R as Reader>::Offset>
where
    R: Reader<Offset = Offset>,
    Offset: ReaderOffset,
{ /* private fields */ }

The common fields for the headers of compilation units and type units.

Implementations

impl<R, Offset> UnitHeader<R, Offset>

where R: Reader<Offset = Offset>, Offset: ReaderOffset,

Static methods.

pub fn new( encoding: Encoding, unit_length: Offset, unit_type: UnitType<Offset>, debug_abbrev_offset: DebugAbbrevOffset<Offset>, section: SectionId, unit_offset: UnitSectionOffset<Offset>, entries_buf: R, ) -> Self

Construct a new UnitHeader.

impl<R, Offset> UnitHeader<R, Offset>

where R: Reader<Offset = Offset>, Offset: ReaderOffset,

Instance methods.

pub fn section(&self) -> SectionId

Get the ID of the section containing this unit.

pub fn offset(&self) -> UnitSectionOffset<Offset>

Get the offset of this unit within its section.

pub fn debug_info_offset(&self) -> Option<DebugInfoOffset<Offset>>

Get the offset of this unit as an offset within the .debug_info section.

Returns None if this unit is not in the .debug_info section.

pub fn debug_types_offset(&self) -> Option<DebugTypesOffset<Offset>>

Get the offset of this unit as an offset within the .debug_types section.

Returns None if this unit is not in the .debug_types section.

pub fn size_of_header(&self) -> usize

Return the serialized size of the common unit header for the given DWARF format.

pub fn unit_length(&self) -> Offset

Get the length of the debugging info for this compilation unit, not including the byte length of the encoded length itself.

pub fn length_including_self(&self) -> Offset

Get the length of the debugging info for this compilation unit, including the byte length of the encoded length itself.

pub fn encoding(&self) -> Encoding

Return the encoding parameters for this unit.

pub fn version(&self) -> u16

Get the DWARF version of the debugging info for this compilation unit.

pub fn type_(&self) -> UnitType<Offset>

Get the UnitType of this unit.

pub fn debug_abbrev_offset(&self) -> DebugAbbrevOffset<Offset>

The offset into the .debug_abbrev section for this compilation unit’s debugging information entries’ abbreviations.

pub fn address_size(&self) -> u8

The size of addresses (in bytes) in this compilation unit.

pub fn format(&self) -> Format

Whether this compilation unit is encoded in 64- or 32-bit DWARF.

pub fn header_size(&self) -> Offset

The serialized size of the header for this compilation unit.

pub fn root_offset(&self) -> UnitOffset<Offset>

The unit offset of the root entry.

pub fn range(&self, idx: Range<UnitOffset<Offset>>) -> Result<R>

Get the underlying bytes for the supplied range.

pub fn range_from(&self, idx: RangeFrom<UnitOffset<Offset>>) -> Result<R>

Get the underlying bytes for the supplied range.

pub fn range_to(&self, idx: RangeTo<UnitOffset<Offset>>) -> Result<R>

Get the underlying bytes for the supplied range.

pub fn entry<'abbrev>( &self, abbreviations: &'abbrev Abbreviations, offset: UnitOffset<Offset>, ) -> Result<DebuggingInformationEntry<R>>

Read the DebuggingInformationEntry at the given offset.

Creating a DebuggingInformationEntry requires an allocation, so frequent use of this method may be slow. Use methods such as Self::entries_at_offset to read multiple entries where possible, or Self::entries_raw which does not allocate.

pub fn entries<'abbrev>( &self, abbreviations: &'abbrev Abbreviations, ) -> EntriesCursor<'abbrev, R>

Navigate this unit’s DebuggingInformationEntrys.

pub fn entries_at_offset<'abbrev>( &self, abbreviations: &'abbrev Abbreviations, offset: UnitOffset<Offset>, ) -> Result<EntriesCursor<'abbrev, R>>

Navigate this compilation unit’s DebuggingInformationEntrys starting at the given offset.

pub fn entries_tree<'abbrev>( &self, abbreviations: &'abbrev Abbreviations, offset: Option<UnitOffset<Offset>>, ) -> Result<EntriesTree<'abbrev, R>>

Navigate this unit’s DebuggingInformationEntrys as a tree starting at the given offset.

pub fn entries_raw<'abbrev>( &self, abbreviations: &'abbrev Abbreviations, offset: Option<UnitOffset<Offset>>, ) -> Result<EntriesRaw<'abbrev, R>>

Read the raw data that defines the Debugging Information Entries.

pub fn abbreviations( &self, debug_abbrev: &DebugAbbrev<R>, ) -> Result<Abbreviations>

Parse this unit’s abbreviations.

pub fn is_tombstone_address(&self, address: u64) -> bool

Return true if the given address is a tombstone.

This currently checks if the address is -1 or -2 for the address size of the unit.

Note that this cannot detect the use of 0 as a tombstone since that is ambiguous. The caller must use their own knowledge of valid address ranges to determine that if required.

Trait Implementations

impl<R, Offset> Clone for UnitHeader<R, Offset>

where R: Reader<Offset = Offset> + Clone, Offset: ReaderOffset + Clone,

fn clone(&self) -> UnitHeader<R, Offset>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R, Offset> Debug for UnitHeader<R, Offset>

where R: Reader<Offset = Offset> + Debug, Offset: ReaderOffset + Debug,

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

Formats the value using the given formatter.

impl<R, Offset> PartialEq for UnitHeader<R, Offset>

where R: Reader<Offset = Offset> + PartialEq, Offset: ReaderOffset + PartialEq,

fn eq(&self, other: &UnitHeader<R, Offset>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R, Offset> Copy for UnitHeader<R, Offset>

where R: Reader<Offset = Offset> + Copy, Offset: ReaderOffset + Copy,

impl<R, Offset> Eq for UnitHeader<R, Offset>

where R: Reader<Offset = Offset> + Eq, Offset: ReaderOffset + Eq,

impl<R, Offset> StructuralPartialEq for UnitHeader<R, Offset>

where R: Reader<Offset = Offset>, Offset: ReaderOffset,