Struct gimli::read::LineProgramHeader
source · [−]pub struct LineProgramHeader<R, Offset = <R as Reader>::Offset> where
R: Reader<Offset = Offset>,
Offset: ReaderOffset, { /* private fields */ }
Expand description
A header for a line number program in the .debug_line
section, as defined
in section 6.2.4 of the standard.
Implementations
sourceimpl<R, Offset> LineProgramHeader<R, Offset> where
R: Reader<Offset = Offset>,
Offset: ReaderOffset,
impl<R, Offset> LineProgramHeader<R, Offset> where
R: Reader<Offset = Offset>,
Offset: ReaderOffset,
sourcepub fn offset(&self) -> DebugLineOffset<R::Offset>
pub fn offset(&self) -> DebugLineOffset<R::Offset>
Return the offset of the line number program header in the .debug_line
section.
sourcepub fn unit_length(&self) -> R::Offset
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.
sourcepub fn encoding(&self) -> Encoding
pub fn encoding(&self) -> Encoding
Return the encoding parameters for this header’s line program.
sourcepub fn header_length(&self) -> R::Offset
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.
sourcepub fn address_size(&self) -> u8
pub fn address_size(&self) -> u8
Get the size in bytes of a target machine address.
sourcepub fn line_encoding(&self) -> LineEncoding
pub fn line_encoding(&self) -> LineEncoding
Get the line encoding parameters for this header’s line program.
sourcepub fn minimum_instruction_length(&self) -> u8
pub fn minimum_instruction_length(&self) -> u8
Get the minimum instruction length any instruction in this header’s line program may have.
sourcepub fn maximum_operations_per_instruction(&self) -> u8
pub fn maximum_operations_per_instruction(&self) -> u8
Get the maximum number of operations each instruction in this header’s line program may have.
sourcepub fn default_is_stmt(&self) -> bool
pub fn default_is_stmt(&self) -> bool
Get the default value of the is_stmt
register for this header’s line
program.
sourcepub fn line_range(&self) -> u8
pub fn line_range(&self) -> u8
Get the line range for this header’s line program.
sourcepub fn opcode_base(&self) -> u8
pub fn opcode_base(&self) -> u8
Get opcode base for this header’s line program.
sourcepub fn standard_opcode_lengths(&self) -> &R
pub fn standard_opcode_lengths(&self) -> &R
An array of u8
that specifies the number of LEB128 operands for
each of the standard opcodes.
sourcepub fn directory_entry_format(&self) -> &[FileEntryFormat]
pub fn directory_entry_format(&self) -> &[FileEntryFormat]
Get the format of a directory entry.
sourcepub fn include_directories(&self) -> &[AttributeValue<R, Offset>]
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.
sourcepub fn directory(&self, directory: u64) -> Option<AttributeValue<R, Offset>>
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.
sourcepub fn file_name_entry_format(&self) -> &[FileEntryFormat]
pub fn file_name_entry_format(&self) -> &[FileEntryFormat]
Get the format of a file name entry.
sourcepub fn file_has_timestamp(&self) -> bool
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.
sourcepub fn file_has_size(&self) -> bool
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.
sourcepub fn file_has_md5(&self) -> bool
pub fn file_has_md5(&self) -> bool
Return true if the file name entry format contains an MD5 field.
sourcepub fn file_names(&self) -> &[FileEntry<R, Offset>]
pub fn file_names(&self) -> &[FileEntry<R, Offset>]
Get the list of source files that appear in this header’s line program.
sourcepub fn file(&self, file: u64) -> Option<&FileEntry<R, Offset>>
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.
sourcepub fn raw_program_buf(&self) -> R
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());
sourcepub fn instructions(&self) -> LineInstructions<R>
pub fn instructions(&self) -> LineInstructions<R>
Iterate over the instructions in this header’s line number program, parsing them as we go.
Trait Implementations
sourceimpl<R: Clone, Offset: Clone> Clone for LineProgramHeader<R, Offset> where
R: Reader<Offset = Offset>,
Offset: ReaderOffset,
impl<R: Clone, Offset: Clone> Clone for LineProgramHeader<R, Offset> where
R: Reader<Offset = Offset>,
Offset: ReaderOffset,
sourcefn clone(&self) -> LineProgramHeader<R, Offset>
fn clone(&self) -> LineProgramHeader<R, Offset>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<R: Debug, Offset: Debug> Debug for LineProgramHeader<R, Offset> where
R: Reader<Offset = Offset>,
Offset: ReaderOffset,
impl<R: Debug, Offset: Debug> Debug for LineProgramHeader<R, Offset> where
R: Reader<Offset = Offset>,
Offset: ReaderOffset,
sourceimpl<R: PartialEq, Offset: PartialEq> PartialEq<LineProgramHeader<R, Offset>> for LineProgramHeader<R, Offset> where
R: Reader<Offset = Offset>,
Offset: ReaderOffset,
impl<R: PartialEq, Offset: PartialEq> PartialEq<LineProgramHeader<R, Offset>> for LineProgramHeader<R, Offset> where
R: Reader<Offset = Offset>,
Offset: ReaderOffset,
sourcefn eq(&self, other: &LineProgramHeader<R, Offset>) -> bool
fn eq(&self, other: &LineProgramHeader<R, Offset>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &LineProgramHeader<R, Offset>) -> bool
fn ne(&self, other: &LineProgramHeader<R, Offset>) -> bool
This method tests for !=
.
impl<R: Eq, Offset: Eq> Eq for LineProgramHeader<R, Offset> where
R: Reader<Offset = Offset>,
Offset: ReaderOffset,
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,
Auto Trait Implementations
impl<R, Offset> RefUnwindSafe for LineProgramHeader<R, Offset> where
Offset: RefUnwindSafe,
R: RefUnwindSafe,
impl<R, Offset> Send for LineProgramHeader<R, Offset> where
Offset: Send,
R: Send,
impl<R, Offset> Sync for LineProgramHeader<R, Offset> where
Offset: Sync,
R: Sync,
impl<R, Offset> Unpin for LineProgramHeader<R, Offset> where
Offset: Unpin,
R: Unpin,
impl<R, Offset> UnwindSafe for LineProgramHeader<R, Offset> where
Offset: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more