Struct gimli::read::LineProgramHeader

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

A header for a line number program in the .debug_line section, as defined in section 6.2.4 of the standard.

Implementations

impl<R, Offset> LineProgramHeader<R, Offset>

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

pub fn offset(&self) -> DebugLineOffset<R::Offset>

Return the offset of the line number program header in the .debug_line section.

pub fn unit_length(&self) -> R::Offset

Return the length of the line number program and header, not including the length of the encoded length itself.

pub fn encoding(&self) -> Encoding

Return the encoding parameters for this header’s line program.

pub fn version(&self) -> u16

Get the version of this header’s line program.

pub fn header_length(&self) -> R::Offset

Get the length of the encoded line number program header, not including the length of the encoded length itself.

pub fn address_size(&self) -> u8

Get the size in bytes of a target machine address.

pub fn format(&self) -> Format

Whether this line program is encoded in 64- or 32-bit DWARF.

pub fn line_encoding(&self) -> LineEncoding

Get the line encoding parameters for this header’s line program.

pub fn minimum_instruction_length(&self) -> u8

Get the minimum instruction length any instruction in this header’s line program may have.

pub fn maximum_operations_per_instruction(&self) -> u8

Get the maximum number of operations each instruction in this header’s line program may have.

pub fn default_is_stmt(&self) -> bool

Get the default value of the is_stmt register for this header’s line program.

pub fn line_base(&self) -> i8

Get the line base for this header’s line program.

pub fn line_range(&self) -> u8

Get the line range for this header’s line program.

pub fn opcode_base(&self) -> u8

Get opcode base for this header’s line program.

pub fn standard_opcode_lengths(&self) -> &R

An array of u8 that specifies the number of LEB128 operands for each of the standard opcodes.

pub fn directory_entry_format(&self) -> &[FileEntryFormat]

Get the format of a directory entry.

pub fn include_directories(&self) -> &[AttributeValue<R, Offset>]

Get the set of include directories for this header’s line program.

For DWARF version <= 4, the compilation’s current directory is not included in the return value, but is implicitly considered to be in the set per spec.

pub fn directory(&self, directory: u64) -> Option<AttributeValue<R, Offset>>

The include directory with the given directory index.

A directory index of 0 corresponds to the compilation unit directory.

pub fn file_name_entry_format(&self) -> &[FileEntryFormat]

Get the format of a file name entry.

pub fn file_has_timestamp(&self) -> bool

Return true if the file entries may have valid timestamps.

Only returns false if we definitely know that all timestamp fields are invalid.

pub fn file_has_size(&self) -> bool

Return true if the file entries may have valid sizes.

Only returns false if we definitely know that all size fields are invalid.

pub fn file_has_md5(&self) -> bool

Return true if the file name entry format contains an MD5 field.

pub fn file_names(&self) -> &[FileEntry<R, Offset>]

Get the list of source files that appear in this header’s line program.

pub fn file(&self, file: u64) -> Option<&FileEntry<R, Offset>>

The source file with the given file index.

A file index of 0 corresponds to the compilation unit file. Note that a file index of 0 is invalid for DWARF version <= 4, but we support it anyway.

pub fn raw_program_buf(&self) -> R

Get the raw, un-parsed EndianSlice containing this header’s line number program.

use gimli::{LineProgramHeader, EndianSlice, NativeEndian};

fn get_line_number_program_header<'a>() -> LineProgramHeader<EndianSlice<'a, NativeEndian>> {
    // Get a line number program header from some offset in a
    // `.debug_line` section...
}

let header = get_line_number_program_header();
let raw_program = header.raw_program_buf();
println!("The length of the raw program in bytes is {}", raw_program.len());

pub fn instructions(&self) -> LineInstructions<R>

Iterate over the instructions in this header’s line number program, parsing them as we go.

Trait Implementations

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R, Offset> Debug for LineProgramHeader<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 LineProgramHeader<R, Offset>

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

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

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

impl<R, Offset> StructuralEq for LineProgramHeader<R, Offset>

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

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

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