ezEngine Release 25.08
Loading...
Searching...
No Matches
ezRawMemoryStreamWriter Class Reference

Maps a raw chunk of memory to the ezStreamReader interface. More...

#include <MemoryStream.h>

Inheritance diagram for ezRawMemoryStreamWriter:

Public Member Functions

 ezRawMemoryStreamWriter (void *pData, ezUInt64 uiDataSize)
 Initialize the raw memory reader with the chunk of memory that is the data storage.
 
template<typename CONTAINER >
 ezRawMemoryStreamWriter (CONTAINER &ref_container)
 Initialize the raw memory reader with the chunk of memory from a standard ez container.
 
void Reset (void *pData, ezUInt64 uiDataSize)
 
template<typename CONTAINER >
void Reset (CONTAINER &ref_container)
 
ezUInt64 GetStorageSize () const
 Returns the total available bytes in the memory stream.
 
ezUInt64 GetNumWrittenBytes () const
 Returns the number of bytes written to the storage.
 
void SetDebugSourceInformation (ezStringView sDebugSourceInformation)
 Allows to set a string as the source of information in the memory stream for debug purposes.
 
virtual ezResult WriteBytes (const void *pWriteBuffer, ezUInt64 uiBytesToWrite) override
 Copies uiBytesToWrite from pWriteBuffer into the memory stream.
 
- Public Member Functions inherited from ezStreamWriter
 ezStreamWriter ()
 Constructor.
 
virtual ~ezStreamWriter ()
 Virtual destructor to ensure correct cleanup.
 
virtual ezResult Flush ()
 Flushes the stream, may be implemented (not necessary to implement the interface correctly) so that user code can ensure that content is written.
 
template<typename T >
ezResult WriteWordValue (const T *pWordValue)
 Helper method to write a word value correctly (copes with potentially different endianess)
 
template<typename T >
ezResult WriteDWordValue (const T *pDWordValue)
 Helper method to write a dword value correctly (copes with potentially different endianess)
 
template<typename T >
ezResult WriteQWordValue (const T *pQWordValue)
 Helper method to write a qword value correctly (copes with potentially different endianess)
 
EZ_ALWAYS_INLINE void WriteVersion (ezTypeVersion version)
 Writes a type version to the stream.
 
template<typename ArrayType , typename ValueType >
ezResult WriteArray (const ezArrayBase< ValueType, ArrayType > &array)
 Writes an array of elements to the stream.
 
template<typename ValueType , ezUInt16 uiSize>
ezResult WriteArray (const ezSmallArrayBase< ValueType, uiSize > &array)
 Writes a small array of elements to the stream.
 
template<typename ValueType , ezUInt32 uiSize>
ezResult WriteArray (const ValueType(&array)[uiSize])
 Writes a C style fixed array.
 
template<typename KeyType , typename Comparer >
ezResult WriteSet (const ezSetBase< KeyType, Comparer > &set)
 Writes a set.
 
template<typename KeyType , typename ValueType , typename Comparer >
ezResult WriteMap (const ezMapBase< KeyType, ValueType, Comparer > &map)
 Writes a map.
 
template<typename KeyType , typename ValueType , typename Hasher >
ezResult WriteHashTable (const ezHashTableBase< KeyType, ValueType, Hasher > &hashTable)
 Writes a hash table (note that the entry order might change on read)
 
ezResult WriteString (const ezStringView sStringView)
 Writes a string.
 

Detailed Description

Maps a raw chunk of memory to the ezStreamReader interface.

Constructor & Destructor Documentation

◆ ezRawMemoryStreamWriter()

template<typename CONTAINER >
ezRawMemoryStreamWriter::ezRawMemoryStreamWriter ( CONTAINER &  ref_container)
inline

Initialize the raw memory reader with the chunk of memory from a standard ez container.

Note
The container must store the data in a contiguous array.

Member Function Documentation

◆ WriteBytes()

ezResult ezRawMemoryStreamWriter::WriteBytes ( const void *  pWriteBuffer,
ezUInt64  uiBytesToWrite 
)
overridevirtual

Copies uiBytesToWrite from pWriteBuffer into the memory stream.

pWriteBuffer must be a valid buffer and must hold that much data.

Implements ezStreamWriter.


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