plStreamWriter Class Reference

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

#include <Stream.h>

Inheritance diagram for plStreamWriter:

Public Member Functions
	plStreamWriter ()
	Constructor.
virtual	~plStreamWriter ()
	Virtual destructor to ensure correct cleanup.
virtual plResult	WriteBytes (const void *pWriteBuffer, plUInt64 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 plResult	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 >
plResult	WriteWordValue (const T *pWordValue)
	Helper method to write a word value correctly (copes with potentially different endianess)
template<typename T >
plResult	WriteDWordValue (const T *pDWordValue)
	Helper method to write a dword value correctly (copes with potentially different endianess)
template<typename T >
plResult	WriteQWordValue (const T *pQWordValue)
	Helper method to write a qword value correctly (copes with potentially different endianess)
PL_ALWAYS_INLINE void	WriteVersion (plTypeVersion version)
	Writes a type version to the stream.
template<typename ArrayType , typename ValueType >
plResult	WriteArray (const plArrayBase< ValueType, ArrayType > &array)
	Writes an array of elements to the stream.
template<typename ValueType , plUInt16 uiSize>
plResult	WriteArray (const plSmallArrayBase< ValueType, uiSize > &array)
	Writes a small array of elements to the stream.
template<typename ValueType , plUInt32 uiSize>
plResult	WriteArray (const ValueType(&array)[uiSize])
	Writes a C style fixed array.
template<typename KeyType , typename Comparer >
plResult	WriteSet (const plSetBase< KeyType, Comparer > &set)
	Writes a set.
template<typename KeyType , typename ValueType , typename Comparer >
plResult	WriteMap (const plMapBase< KeyType, ValueType, Comparer > &map)
	Writes a map.
template<typename KeyType , typename ValueType , typename Hasher >
plResult	WriteHashTable (const plHashTableBase< KeyType, ValueType, Hasher > &hashTable)
	Writes a hash table (note that the entry order might change on read)
plResult	WriteString (const plStringView sStringView)
	Writes a string.

Detailed Description

Interface for binary out (write) streams.

Member Function Documentation

Flush()

virtual plResult plStreamWriter::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 plFileWriter.

WriteBytes()

virtual plResult plStreamWriter::WriteBytes ( const void * pWriteBuffer, plUInt64 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 plChunkStreamWriter, plDeferredFileWriter, plFileWriter, plHashStreamWriter32, plHashStreamWriter64, plMemoryStreamWriter, and plRawMemoryStreamWriter.

---

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

• Code/Engine/Foundation/IO/Stream.h
• Code/Engine/Foundation/IO/Implementation/Stream.cpp
• Code/Engine/Foundation/IO/Implementation/Stream_inl.h