Trait gimli::Reader[−][src]

pub trait Reader: Debug + Clone {
    type Endian: Endianity;
    type Offset: ReaderOffset;
    fn endian(&self) -> Self::Endian;

    fn len(&self) -> Self::Offset;

    fn empty(&mut self);

    fn truncate(&mut self, len: Self::Offset) -> Result<()>;

    fn offset_from(&self, base: &Self) -> Self::Offset;

    fn find(&self, byte: u8) -> Result<Self::Offset>;

    fn skip(&mut self, len: Self::Offset) -> Result<()>;

    fn split(&mut self, len: Self::Offset) -> Result<Self>;

    fn to_slice(&self) -> Result<Cow<[u8]>>;

    fn to_string(&self) -> Result<Cow<str>>;

    fn to_string_lossy(&self) -> Result<Cow<str>>;

    fn read_u8_array<A>(&mut self) -> Result<A>
    where
        A: Sized + Default + AsMut<[u8]>;

    fn is_empty(&self) -> bool { ... }

    fn read_u8(&mut self) -> Result<u8> { ... }

    fn read_i8(&mut self) -> Result<i8> { ... }

    fn read_u16(&mut self) -> Result<u16> { ... }

    fn read_i16(&mut self) -> Result<i16> { ... }

    fn read_u32(&mut self) -> Result<u32> { ... }

    fn read_i32(&mut self) -> Result<i32> { ... }

    fn read_u64(&mut self) -> Result<u64> { ... }

    fn read_i64(&mut self) -> Result<i64> { ... }

    fn read_f32(&mut self) -> Result<f32> { ... }

    fn read_f64(&mut self) -> Result<f64> { ... }

    fn read_null_terminated_slice(&mut self) -> Result<Self> { ... }

    fn read_uleb128(&mut self) -> Result<u64> { ... }

    fn read_sleb128(&mut self) -> Result<i64> { ... }

    fn read_address(&mut self, address_size: u8) -> Result<u64> { ... }

    fn read_word(&mut self, format: Format) -> Result<u64> { ... }

    fn read_offset(&mut self, format: Format) -> Result<Self::Offset> { ... }
}

A trait for reading the data from a DWARF section.

All read operations advance the section offset of the reader unless specified otherwise.

Choosing a Reader Implementation

gimli comes with a few different Reader implementations and lets you choose the one that is right for your use case. A Reader is essentially a view into the raw bytes that make up some DWARF, but this view might borrow the underlying data or use reference counting ownership, and it might be thread safe or not.

Implementation Ownership Thread Safe Notes
EndianSlice Borrowed Yes Fastest, but requires that all of your code work with borrows.
EndianRcSlice Reference counted No Shared ownership via reference counting, which alleviates the borrow restrictions of EndianSlice but imposes reference counting increments and decrements. Cannot be sent across threads, because the reference count is not atomic.
EndianArcSlice Reference counted Yes The same as EndianRcSlice, but uses atomic reference counting, and therefore reference counting operations are slower but EndianArcSlices may be sent across threads.
EndianReader<T> Same as T Same as T Escape hatch for easily defining your own type of Reader.

Associated Types

The endianity of bytes that are read.

The type used for offsets and lengths.

Required Methods

Return the endianity of bytes that are read.

Return the number of bytes remaining.

Set the number of bytes remaining to zero.

Set the number of bytes remaining to the specified length.

Return the offset of this reader's data relative to the start of the given base reader's data.

May panic if this reader's data is not contained within the given base reader's data.

Find the index of the first occurence of the given byte. The offset of the reader is not changed.

Discard the specified number of bytes.

Split a reader in two.

A new reader is returned that can be used to read the next len bytes, and self is advanced so that it reads the remainder.

Return all remaining data as a clone-on-write slice.

The slice will be borrowed where possible, but some readers may always return an owned vector.

Does not advance the reader.

Convert all remaining data to a clone-on-write string.

The string will be borrowed where possible, but some readers may always return an owned string.

Does not advance the reader.

Returns an error if the data contains invalid characters.

Convert all remaining data to a clone-on-write string, including invalid characters.

The string will be borrowed where possible, but some readers may always return an owned string.

Does not advance the reader.

Read a u8 array.

Provided Methods

Return true if the number of bytes remaining is zero.

Read a u8.

Read an i8.

Read a u16.

Read an i16.

Read a u32.

Read an i32.

Read a u64.

Read an i64.

Read a f32.

Read a f64.

Read a null-terminated slice, and return it (excluding the null).

Read an unsigned LEB128 encoded integer.

Read a signed LEB128 encoded integer.

Read an address-sized integer, and return it as a u64.

Parse a word-sized integer according to the DWARF format, and return it as a u64.

Parse a word-sized integer according to the DWARF format, and return it as an offset.

Implementors