Class that is used to a read stream of data from different sources. More...

#include <BinaryStream.hpp>

Inheritance diagram for LIEF::BinaryStream:

[legend]

Public Types
enum class	STREAM_TYPE { UNKNOWN = 0 , VECTOR , MEMORY , SPAN , FILE , ELF_DATA_HANDLER }

Public Member Functions
	BinaryStream (STREAM_TYPE type)
virtual	~BinaryStream ()=default
virtual uint64_t	size () const =0
STREAM_TYPE	type () const
result< uint64_t >	read_uleb128 () const
result< uint64_t >	read_sleb128 () const
result< int64_t >	read_dwarf_encoded (uint8_t encoding) const
result< std::string >	read_string (size_t maxsize=~static_cast< size_t >(0)) const
result< std::string >	peek_string (size_t maxsize=~static_cast< size_t >(0)) const
result< std::string >	peek_string_at (size_t offset, size_t maxsize=~static_cast< size_t >(0)) const
result< std::u16string >	read_u16string () const
result< std::u16string >	peek_u16string () const
result< std::string >	read_mutf8 (size_t maxsize=~static_cast< size_t >(0)) const
result< std::u16string >	read_u16string (size_t length) const
result< std::u16string >	peek_u16string (size_t length) const
result< std::u16string >	peek_u16string_at (size_t offset, size_t length) const
virtual ok_error_t	peek_data (std::vector< uint8_t > &container, uint64_t offset, uint64_t size, uint64_t virtual_address=0)
virtual ok_error_t	read_data (std::vector< uint8_t > &container, uint64_t size)
ok_error_t	read_data (std::vector< uint8_t > &container)
template<class T>
ok_error_t	read_objects (std::vector< T > &container, uint64_t count)
template<class T>
ok_error_t	peek_objects (std::vector< T > &container, uint64_t count)
template<class T>
ok_error_t	peek_objects_at (uint64_t offset, std::vector< T > &container, uint64_t count)
void	setpos (size_t pos) const
const BinaryStream &	increment_pos (size_t value) const
void	decrement_pos (size_t value) const
size_t	pos () const
	operator bool () const
template<class T>
const T *	read_array (size_t size) const
template<class T, size_t N>
ok_error_t	peek_array (std::array< T, N > &dst) const
template<class T, size_t N>
ok_error_t	read_array (std::array< T, N > &dst) const
template<class T>
result< T >	peek () const
template<class T>
result< T >	peek (size_t offset) const
template<class T>
const T *	peek_array (size_t size) const
template<class T>
const T *	peek_array (size_t offset, size_t size) const
template<class T>
result< T >	read () const
template<typename T>
bool	can_read () const
template<typename T>
bool	can_read (size_t offset) const
bool	can_read (int64_t offset, int64_t size) const
size_t	align (size_t align_on) const
void	set_endian_swap (bool swap)
bool	should_swap () const
virtual const uint8_t *	p () const
virtual uint8_t *	start ()
virtual uint8_t *	p ()
virtual uint8_t *	end ()
virtual const uint8_t *	start () const
virtual const uint8_t *	end () const
virtual result< const void * >	read_at (uint64_t offset, uint64_t size, uint64_t virtual_address=0) const =0
virtual ok_error_t	peek_in (void *dst, uint64_t offset, uint64_t size, uint64_t virtual_address=0) const

Static Public Member Functions
template<class T>
static bool	is_all_zero (const T &buffer)

Detailed Description

Class that is used to a read stream of data from different sources.

Member Enumeration Documentation

◆ STREAM_TYPE

enum class LIEF::BinaryStream::STREAM_TYPE

strong

Enumerator
UNKNOWN
VECTOR
MEMORY
SPAN
FILE
ELF_DATA_HANDLER

Constructor & Destructor Documentation

◆ BinaryStream()

LIEF::BinaryStream::BinaryStream ( STREAM_TYPE type )

inline

References type().

Referenced by LIEF::FileStream::classof(), LIEF::MemoryStream::classof(), LIEF::SpanStream::classof(), LIEF::VectorStream::classof(), end(), LIEF::FileStream::FileStream(), increment_pos(), LIEF::MemoryStream::MemoryStream(), p(), LIEF::SpanStream::SpanStream(), start(), and LIEF::VectorStream::VectorStream().

◆ ~BinaryStream()

virtual LIEF::BinaryStream::~BinaryStream ( )

virtualdefault

Member Function Documentation

◆ align()

size_t LIEF::BinaryStream::align ( size_t align_on ) const

◆ can_read() [1/3]

template<typename T>

bool LIEF::BinaryStream::can_read ( ) const

References size().

Referenced by peek_objects_at().

◆ can_read() [2/3]

bool LIEF::BinaryStream::can_read	(	int64_t	offset,
		int64_t	size ) const

inline

References size().

◆ can_read() [3/3]

template<typename T>

bool LIEF::BinaryStream::can_read ( size_t offset ) const

References size().

◆ decrement_pos()

void LIEF::BinaryStream::decrement_pos ( size_t value ) const

inline

◆ end() [1/2]

virtual uint8_t * LIEF::BinaryStream::end ( )

inlinevirtual

Reimplemented in LIEF::MemoryStream, LIEF::SpanStream, and LIEF::VectorStream.

References BinaryStream().

◆ end() [2/2]

virtual const uint8_t * LIEF::BinaryStream::end ( ) const

inlinevirtual

Reimplemented in LIEF::MemoryStream, LIEF::SpanStream, and LIEF::VectorStream.

◆ increment_pos()

const BinaryStream & LIEF::BinaryStream::increment_pos ( size_t value ) const

inline

References BinaryStream().

Referenced by read(), read_array(), read_array(), read_data(), and read_objects().

◆ is_all_zero()

template<class T>

bool LIEF::BinaryStream::is_all_zero ( const T & buffer )

inlinestatic

◆ operator bool()

LIEF::BinaryStream::operator bool ( ) const

inline

References size().

◆ p() [1/2]

virtual uint8_t * LIEF::BinaryStream::p ( )

inlinevirtual

Reimplemented in LIEF::MemoryStream, LIEF::SpanStream, and LIEF::VectorStream.

References BinaryStream().

◆ p() [2/2]

virtual const uint8_t * LIEF::BinaryStream::p ( ) const

inlinevirtual

Reimplemented in LIEF::MemoryStream, LIEF::SpanStream, and LIEF::VectorStream.

◆ peek() [1/2]

template<class T>

result< T > LIEF::BinaryStream::peek ( ) const

References make_error_code(), peek_in(), pos(), read_error, setpos(), and LIEF::swap_endian().

Referenced by peek(), and read().

◆ peek() [2/2]

template<class T>

result< T > LIEF::BinaryStream::peek ( size_t offset ) const

References peek(), pos(), and setpos().

◆ peek_array() [1/3]

template<class T>

const T * LIEF::BinaryStream::peek_array	(	size_t	offset,
		size_t	size ) const

References peek_array(), pos(), setpos(), and size().

◆ peek_array() [2/3]

template<class T>

const T * LIEF::BinaryStream::peek_array ( size_t size ) const

References pos(), read_at(), and size().

◆ peek_array() [3/3]

template<class T, size_t N>

ok_error_t LIEF::BinaryStream::peek_array ( std::array< T, N > & dst ) const

inline

References make_error_code(), LIEF::ok(), peek_in(), read_error, and size().

Referenced by peek_array(), read_array(), and read_array().

◆ peek_data()

virtual ok_error_t LIEF::BinaryStream::peek_data	(	std::vector< uint8_t > &	container,
		uint64_t	offset,
		uint64_t	size,
		uint64_t	virtual_address = 0 )

inlinevirtual

References make_error_code(), LIEF::ok(), peek_in(), read_error, and size().

Referenced by read_data().

◆ peek_in()

virtual ok_error_t LIEF::BinaryStream::peek_in	(	void *	dst,
		uint64_t	offset,
		uint64_t	size,
		uint64_t	virtual_address = 0 ) const

inlinevirtual

Reimplemented in LIEF::FileStream.

References make_error_code(), LIEF::ok(), read_at(), read_error, and size().

Referenced by peek(), peek_array(), peek_data(), and peek_objects_at().

◆ peek_objects()

template<class T>

ok_error_t LIEF::BinaryStream::peek_objects	(	std::vector< T > &	container,
		uint64_t	count )

inline

References peek_objects_at(), and pos().

Referenced by read_objects().

◆ peek_objects_at()

template<class T>

ok_error_t LIEF::BinaryStream::peek_objects_at	(	uint64_t	offset,
		std::vector< T > &	container,
		uint64_t	count )

inline

References can_read(), make_error_code(), LIEF::ok(), peek_in(), pos(), read_error, setpos(), and size().

Referenced by peek_objects().

◆ peek_string()

result< std::string > LIEF::BinaryStream::peek_string ( size_t maxsize = ~static_cast< size_t >(0) ) const

◆ peek_string_at()

result< std::string > LIEF::BinaryStream::peek_string_at	(	size_t	offset,
		size_t	maxsize = ~static_cast< size_t >(0) ) const

◆ peek_u16string() [1/2]

result< std::u16string > LIEF::BinaryStream::peek_u16string ( ) const

◆ peek_u16string() [2/2]

result< std::u16string > LIEF::BinaryStream::peek_u16string ( size_t length ) const

◆ peek_u16string_at()

result< std::u16string > LIEF::BinaryStream::peek_u16string_at	(	size_t	offset,
		size_t	length ) const

◆ pos()

size_t LIEF::BinaryStream::pos ( ) const

inline

Referenced by LIEF::MemoryStream::p(), LIEF::SpanStream::p(), LIEF::VectorStream::p(), peek(), peek(), peek_array(), peek_array(), LIEF::FileStream::peek_in(), peek_objects(), peek_objects_at(), read_data(), read_data(), and setpos().

◆ read()

template<class T>

result< T > LIEF::BinaryStream::read ( ) const

References increment_pos(), and peek().

◆ read_array() [1/2]

template<class T>

const T * LIEF::BinaryStream::read_array ( size_t size ) const

References increment_pos(), peek_array(), and size().

◆ read_array() [2/2]

template<class T, size_t N>

ok_error_t LIEF::BinaryStream::read_array ( std::array< T, N > & dst ) const

inline

References increment_pos(), make_error_code(), LIEF::ok(), peek_array(), and read_error.

◆ read_at()

virtual result< const void * > LIEF::BinaryStream::read_at	(	uint64_t	offset,
		uint64_t	size,
		uint64_t	virtual_address = 0 ) const

pure virtual

Implemented in LIEF::FileStream.

References size().

Referenced by peek_array(), and peek_in().

◆ read_data() [1/2]

ok_error_t LIEF::BinaryStream::read_data ( std::vector< uint8_t > & container )

inline

References pos(), read_data(), and size().

◆ read_data() [2/2]

virtual ok_error_t LIEF::BinaryStream::read_data	(	std::vector< uint8_t > &	container,
		uint64_t	size )

inlinevirtual

References increment_pos(), make_error_code(), LIEF::ok(), peek_data(), pos(), read_error, and size().

Referenced by read_data().

◆ read_dwarf_encoded()

result< int64_t > LIEF::BinaryStream::read_dwarf_encoded ( uint8_t encoding ) const

◆ read_mutf8()

result< std::string > LIEF::BinaryStream::read_mutf8 ( size_t maxsize = ~static_cast< size_t >(0) ) const

◆ read_objects()

template<class T>

ok_error_t LIEF::BinaryStream::read_objects	(	std::vector< T > &	container,
		uint64_t	count )

inline

References increment_pos(), make_error_code(), LIEF::ok(), peek_objects(), read_error, and size().

◆ read_sleb128()

result< uint64_t > LIEF::BinaryStream::read_sleb128 ( ) const

◆ read_string()

result< std::string > LIEF::BinaryStream::read_string ( size_t maxsize = ~static_cast< size_t >(0) ) const

◆ read_u16string() [1/2]

result< std::u16string > LIEF::BinaryStream::read_u16string ( ) const

◆ read_u16string() [2/2]

result< std::u16string > LIEF::BinaryStream::read_u16string ( size_t length ) const

◆ read_uleb128()

result< uint64_t > LIEF::BinaryStream::read_uleb128 ( ) const

◆ set_endian_swap()

void LIEF::BinaryStream::set_endian_swap ( bool swap )

inline

Referenced by LIEF::ToggleEndianness::ToggleEndianness(), and LIEF::ToggleEndianness::ToggleEndianness().

◆ setpos()

void LIEF::BinaryStream::setpos ( size_t pos ) const

inline

References pos().

Referenced by peek(), peek(), peek_array(), peek_objects_at(), and LIEF::ScopedStream::ScopedStream().

◆ should_swap()

bool LIEF::BinaryStream::should_swap ( ) const

inline

◆ size()

virtual uint64_t LIEF::BinaryStream::size ( ) const

pure virtual

Implemented in LIEF::FileStream, LIEF::MemoryStream, LIEF::SpanStream, and LIEF::VectorStream.

Referenced by can_read(), can_read(), can_read(), operator bool(), peek_array(), peek_array(), peek_array(), peek_data(), peek_in(), peek_objects_at(), read_array(), read_at(), read_data(), read_data(), and read_objects().

◆ start() [1/2]

virtual uint8_t * LIEF::BinaryStream::start ( )

inlinevirtual

Reimplemented in LIEF::MemoryStream, LIEF::SpanStream, and LIEF::VectorStream.

References BinaryStream().

◆ start() [2/2]

virtual const uint8_t * LIEF::BinaryStream::start ( ) const

inlinevirtual

Reimplemented in LIEF::MemoryStream, LIEF::SpanStream, and LIEF::VectorStream.

◆ type()

STREAM_TYPE LIEF::BinaryStream::type ( ) const

inline

Referenced by BinaryStream(), LIEF::FileStream::classof(), LIEF::MemoryStream::classof(), LIEF::SpanStream::classof(), and LIEF::VectorStream::classof().

The documentation for this class was generated from the following file:

BinaryStream.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ STREAM_TYPE

Constructor & Destructor Documentation

◆ BinaryStream()

◆ ~BinaryStream()

Member Function Documentation

◆ align()

◆ can_read() [1/3]

◆ can_read() [2/3]

◆ can_read() [3/3]

◆ decrement_pos()

◆ end() [1/2]

◆ end() [2/2]

◆ increment_pos()

◆ is_all_zero()

◆ operator bool()

◆ p() [1/2]

◆ p() [2/2]

◆ peek() [1/2]

◆ peek() [2/2]

◆ peek_array() [1/3]

◆ peek_array() [2/3]

◆ peek_array() [3/3]

◆ peek_data()

◆ peek_in()

◆ peek_objects()

◆ peek_objects_at()

◆ peek_string()

◆ peek_string_at()

◆ peek_u16string() [1/2]

◆ peek_u16string() [2/2]

◆ peek_u16string_at()

◆ pos()

◆ read()

◆ read_array() [1/2]

◆ read_array() [2/2]

◆ read_at()

◆ read_data() [1/2]

◆ read_data() [2/2]

◆ read_dwarf_encoded()

◆ read_mutf8()

◆ read_objects()

◆ read_sleb128()

◆ read_string()

◆ read_u16string() [1/2]

◆ read_u16string() [2/2]

◆ read_uleb128()

◆ set_endian_swap()

◆ setpos()

◆ should_swap()

◆ size()

◆ start() [1/2]

◆ start() [2/2]

◆ type()