ezStreamReader Class Reference

Interface for binary in (read) streams. More...

#include <Stream.h>

Inheritance diagram for ezStreamReader:

Public Member Functions
	ezStreamReader ()
	Constructor.
virtual	~ezStreamReader ()
	Virtual destructor to ensure correct cleanup.
virtual ezUInt64	ReadBytes (void *pReadBuffer, ezUInt64 uiBytesToRead)=0
	Reads a raw number of bytes into the read buffer, this is the only method which has to be implemented to fully implement the interface.
template<typename T >
ezResult	ReadWordValue (T *pWordValue)
	Helper method to read a word value correctly (copes with potentially different endianess)
template<typename T >
ezResult	ReadDWordValue (T *pDWordValue)
	Helper method to read a dword value correctly (copes with potentially different endianess)
template<typename T >
ezResult	ReadQWordValue (T *pQWordValue)
	Helper method to read a qword value correctly (copes with potentially different endianess)
template<typename ArrayType , typename ValueType >
ezResult	ReadArray (ezArrayBase< ValueType, ArrayType > &inout_array)
	Reads an array of elements from the stream.
template<typename ValueType , ezUInt16 uiSize, typename AllocatorWrapper >
ezResult	ReadArray (ezSmallArray< ValueType, uiSize, AllocatorWrapper > &ref_array)
	Reads a small array of elements from the stream.
template<typename ValueType , ezUInt32 uiSize>
ezResult	ReadArray (ValueType(&array)[uiSize])
	Writes a C style fixed array.
template<typename KeyType , typename Comparer >
ezResult	ReadSet (ezSetBase< KeyType, Comparer > &inout_set)
	Reads a set.
template<typename KeyType , typename ValueType , typename Comparer >
ezResult	ReadMap (ezMapBase< KeyType, ValueType, Comparer > &inout_map)
	Reads a map.
template<typename KeyType , typename ValueType , typename Hasher >
ezResult	ReadHashTable (ezHashTableBase< KeyType, ValueType, Hasher > &inout_hashTable)
	Read a hash table (note that the entry order is not stable)
ezResult	ReadString (ezStringBuilder &ref_sBuilder)
	Reads a string into an ezStringBuilder.
ezResult	ReadString (ezString &ref_sString)
	Reads a string into an ezString.
virtual ezUInt64	SkipBytes (ezUInt64 uiBytesToSkip)
	Helper method to skip a number of bytes (implementations of the stream reader may implement this more efficiently for example)
EZ_ALWAYS_INLINE ezTypeVersion	ReadVersion (ezTypeVersion expectedMaxVersion)

Detailed Description

Interface for binary in (read) streams.

Member Function Documentation

ReadBytes()

virtual ezUInt64 ezStreamReader::ReadBytes ( void *  pReadBuffer, ezUInt64  uiBytesToRead  )

pure virtual

Reads a raw number of bytes into the read buffer, this is the only method which has to be implemented to fully implement the interface.

Implemented in ezChunkStreamReader, ezFileReader, ezMemoryStreamReader, ezRawMemoryStreamReader, and ezStreamReaderWithStats.

SkipBytes()

virtual ezUInt64 ezStreamReader::SkipBytes ( ezUInt64  uiBytesToSkip )

inlinevirtual

Helper method to skip a number of bytes (implementations of the stream reader may implement this more efficiently for example)

Reimplemented in ezFileReader, ezMemoryStreamReader, ezRawMemoryStreamReader, and ezStreamReaderWithStats.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/IO/Stream.h
• /home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/IO/Implementation/Stream.cpp
• /home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/IO/Implementation/Stream_inl.h