 |
XII Release 0.1.0
|
|
XII Release 0.1.0
|
A writer which can access a memory stream. More...
#include <MemoryStream.h>
Public Member Functions | |
| xiiMemoryStreamWriter (xiiMemoryStreamStorageInterface *pStreamStorage=nullptr) | |
| Pass the memory storage object to which to write to. | |
| void | SetStorage (xiiMemoryStreamStorageInterface *pStreamStorage) |
| Sets the storage object upon which to operate. Resets the write position to the end of the storage stream. Pass nullptr if you want to detach from any previous storage stream, for example to ensure its reference count gets properly reduced. | |
| virtual xiiResult | WriteBytes (const void *pWriteBuffer, xiiUInt64 uiBytesToWrite) override |
| Copies uiBytesToWrite from pWriteBuffer into the memory stream. | |
| void | SetWritePosition (xiiUInt64 uiWritePosition) |
| Sets the write position to be used. | |
| xiiUInt64 | GetWritePosition () const |
| Returns the current write position. | |
| xiiUInt32 | GetByteCount32 () const |
| Returns the total stored bytes in the memory stream. | |
| xiiUInt64 | GetByteCount64 () const |
 Public Member Functions inherited from xiiStreamWriter | |
| xiiStreamWriter () | |
| Constructor. | |
| virtual | ~xiiStreamWriter () |
| Virtual destructor to ensure correct cleanup. | |
| 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. | |
A writer which can access a memory stream.
Please note that the functions exposed by this object are not thread safe!
|
overridevirtual |
Copies uiBytesToWrite from pWriteBuffer into the memory stream.
pWriteBuffer must be a valid buffer and must hold that much data.
Implements xiiStreamWriter.
1.13.2