xiiStreamWriter Class Reference

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

#include <Stream.h>

Inheritance diagram for xiiStreamWriter:

Public Member Functions
	xiiStreamWriter ()
	Constructor.
virtual	~xiiStreamWriter ()
	Virtual destructor to ensure correct cleanup.
virtual xiiResult	WriteBytes (const void *pWriteBuffer, xiiUInt64 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 xiiResult	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>
xiiResult	WriteWordValue (const T *pWordValue)
	Helper method to write a word value correctly (copes with potentially different endianess).
template<typename T>
xiiResult	WriteDWordValue (const T *pDWordValue)
	Helper method to write a dword value correctly (copes with potentially different endianess).
template<typename T>
xiiResult	WriteQWordValue (const T *pQWordValue)
	Helper method to write a qword value correctly (copes with potentially different endianess).
XII_ALWAYS_INLINE void	WriteVersion (xiiTypeVersion version)
	Writes a type version to the stream.
template<typename ArrayType, typename ValueType>
xiiResult	WriteArray (const xiiArrayBase< ValueType, ArrayType > &array)
	Writes an array of elements to the stream.
template<typename ValueType, xiiUInt16 uiSize>
xiiResult	WriteArray (const xiiSmallArrayBase< ValueType, uiSize > &array)
	Writes a small array of elements to the stream.
template<typename ValueType, xiiUInt32 uiSize>
xiiResult	WriteArray (const ValueType(&array)[uiSize])
	Writes a C style fixed array.
template<typename KeyType, typename Comparer>
xiiResult	WriteSet (const xiiSetBase< KeyType, Comparer > &set)
	Writes a set.
template<typename KeyType, typename ValueType, typename Comparer>
xiiResult	WriteMap (const xiiMapBase< KeyType, ValueType, Comparer > &map)
	Writes a map.
template<typename KeyType, typename ValueType, typename Hasher>
xiiResult	WriteHashTable (const xiiHashTableBase< KeyType, ValueType, Hasher > &hashTable)
	Writes a hash table (note that the entry order might change on read)
xiiResult	WriteString (const xiiStringView sStringView)
	Writes a string.

Detailed Description

Interface for binary out (write) streams.

Member Function Documentation

Flush()

virtual xiiResult xiiStreamWriter::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 xiiFileWriter, and xiiStreamWriterWithStats.

WriteBytes()

virtual xiiResult xiiStreamWriter::WriteBytes ( const void * pWriteBuffer, xiiUInt64 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 xiiChunkStreamWriter, xiiDeferredFileWriter, xiiFileWriter, xiiHashStreamWriter32, xiiHashStreamWriter64, xiiMemoryStreamWriter, xiiRawMemoryStreamWriter, and xiiStreamWriterWithStats.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/IO/Stream.h
• /home/runner/work/XII/XII/Source/Engine/Foundation/IO/Implementation/Stream.cpp
• /home/runner/work/XII/XII/Source/Engine/Foundation/IO/Implementation/Stream_inl.h