ezEngine  Milestone 9
ezStreamReader Class Referenceabstract

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 > &Array)
 Reads an 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 > &Set)
 Reads a set.
 
template<typename KeyType , typename ValueType , typename Comparer >
ezResult ReadMap (ezMapBase< KeyType, ValueType, Comparer > &Map)
 Reads a map.
 
ezResult ReadString (ezStringBuilder &builder)
 Reads a string into a ezStringBuilder.
 
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 uiExpectedMaxVersion)
 

Detailed Description

Interface for binary in (read) streams.


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