Struct NameIndex 

pub struct NameIndex<R: Reader> { /* private fields */ }

A single name index from the .debug_names section.

It provides access to the compilation unit table, type unit tables, hash table, name table, and entry pool that make up the accelerated lookup structure.

Implementations

impl<R: Reader> NameIndex<R>

pub fn new(header: NameIndexHeader<R>) -> Result<Self>

Create a new name index from a header.

pub fn compile_unit_count(&self) -> u32

Return the number of compilation units in this index.

pub fn compile_unit(&self, index: u32) -> Result<DebugInfoOffset<R::Offset>>

Get the .debug_info offset of a compilation unit.

index must be less than Self::compile_unit_count.

Returns an error if index is invalid.

pub fn default_compile_unit(&self) -> Result<Option<DebugInfoOffset<R::Offset>>>

Return the .debug_info offset of the default compilation unit, if any.

If there is only one compilation unit, then entries may omit the DW_IDX_compile_unit attribute.

pub fn local_type_unit_count(&self) -> u32

Return the number of local type units in this index.

pub fn local_type_unit(&self, index: u32) -> Result<DebugInfoOffset<R::Offset>>

Get the .debug_info offset of a local type unit.

index must be less than Self::local_type_unit_count.

Returns an error if index is invalid.

pub fn foreign_type_unit_count(&self) -> u32

Return the number of foreign type units in this index.

pub fn foreign_type_unit(&self, index: u32) -> Result<DebugTypeSignature>

Get the signature of a foreign type unit.

index must be less than Self::foreign_type_unit_count.

Returns an error if index is invalid.

pub fn type_unit_count(&self) -> u32

Return the number of type units in this index, both local and foreign.

pub fn type_unit(&self, index: u32) -> Result<NameTypeUnit<R::Offset>>

Get a type unit reference.

index must be less than Self::type_unit_count, and normally is obtained from a DW_IDX_type_unit attribute.

Returns an error if index is invalid.

pub fn has_hash_table(&self) -> bool

Return true if the name index contains a hash table.

pub fn bucket_count(&self) -> u32

Return the number of buckets in the hash table.

pub fn find_by_bucket( &self, bucket_index: u32, ) -> Result<Option<NameBucketIter<R>>>

Iterate over the hash entries for a bucket in the hash table.

This function is only for diagnostic uses. Usually Self::find_by_hash should be called instead.

The given bucket index is 0 based, and must be less than Self::bucket_count.

Returns an error if there is no hash table or the bucket index is invalid. Returns Ok(None) if the bucket is empty.

pub fn find_by_hash(&self, hash_value: u32) -> Result<NameHashIter<R>>

Iterate over the indexes of the names with the given hash value.

The user must then check each name to see if it matches the desired name.

Returns an error if there is no hash table.

pub fn name_count(&self) -> u32

Get the number of names in the name index.

This is 1 greater than the maximum valid NameTableIndex.

pub fn names(&self) -> NameTableIter

Iterate over the indexes of all names in the name table.

pub fn name_string_offset( &self, index: NameTableIndex, ) -> Result<DebugStrOffset<R::Offset>>

Get the string table offset for the name at the given index.

Returns an error if index is invalid.

pub fn name_string( &self, index: NameTableIndex, debug_str: &DebugStr<R>, ) -> Result<R>

Get the name at the given index using the provided .debug_str section.

Returns an error if index is invalid, or the string table offset is invalid.

pub fn name_entries( &self, index: NameTableIndex, ) -> Result<NameEntryIter<'_, R>>

Iterate over the series of entries for the given name table index.

Each name in the name table has a corresponding series of entries with that name in the entry pool.

Returns an error if index is invalid, or the entry pool offset is invalid.

pub fn name_entry( &self, offset: NameEntryOffset<R::Offset>, ) -> Result<NameEntry<R>>

Parse the entry at the given entry pool offset.

This is useful for reading the entry referenced by a DW_IDX_parent attribute.

pub fn abbreviations(&self) -> &NameAbbreviations

Get the abbreviation table for name entries in this name index.

Trait Implementations

impl<R: Debug + Reader> Debug for NameIndex<R>

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

Formats the value using the given formatter.