ezStreamWriter Class Reference

Interface for binary out (write) streams. More...

#include <Stream.h>

Inheritance diagram for ezStreamWriter:

Public Member Functions
	ezStreamWriter ()
	Constructor.
virtual	~ezStreamWriter ()
	Virtual destructor to ensure correct cleanup.
virtual ezResult	WriteBytes (const void *pWriteBuffer, ezUInt64 uiBytesToWrite)=0
	Writes a raw number of bytes from the buffer, this is the only method which has to be implemented to fully implement the interface.
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

Interface for binary out (write) streams.

Member Function Documentation

Flush()

virtual ezResult ezStreamWriter::Flush ( )

inlinevirtual

Flushes the stream, may be implemented (not necessary to implement the interface correctly) so that user code can ensure that content is written.

Reimplemented in ezFileWriter, and ezStreamWriterWithStats.

WriteBytes()

virtual ezResult ezStreamWriter::WriteBytes ( const void *  pWriteBuffer, ezUInt64  uiBytesToWrite  )

pure virtual

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

Implemented in ezHashStreamWriter32, ezHashStreamWriter64, ezChunkStreamWriter, ezDeferredFileWriter, ezFileWriter, ezMemoryStreamWriter, ezRawMemoryStreamWriter, and ezStreamWriterWithStats.

---

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