 |
Plasma Engine
2.0
|
|
Plasma Engine
2.0
|
A file writer that caches all written data and only opens and writes to the output file when everything is finished. Useful to ensure that only complete files are written, or nothing at all, in case of a crash. More...
#include <DeferredFileWriter.h>
Public Member Functions | |
| ~plDeferredFileWriter () | |
| Upon destruction the file is closed and thus written, unless Discard was called before. | |
| void | SetOutput (plStringView sFileToWriteTo, bool bOnlyWriteIfDifferent=false) |
| This must be configured before anything is written to the file. | |
| virtual plResult | WriteBytes (const void *pWriteBuffer, plUInt64 uiBytesToWrite) override |
| Writes a raw number of bytes from the buffer, this is the only method which has to be implemented to fully implement the interface. | |
| plResult | Close (bool *out_pWasWrittenTo=nullptr) |
| Upon calling this the content is written to the file specified with SetOutput(). The return value is PL_FAILURE if the file could not be opened or not completely written. | |
| void | Discard () |
| Calling this abandons the content and a later Close or destruction of the instance will no longer write anything to file. | |
 Public Member Functions inherited from plStreamWriter | |
| plStreamWriter () | |
| Constructor. | |
| virtual | ~plStreamWriter () |
| Virtual destructor to ensure correct cleanup. | |
| 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. | |
A file writer that caches all written data and only opens and writes to the output file when everything is finished. Useful to ensure that only complete files are written, or nothing at all, in case of a crash.
|
overridevirtual |
Writes a raw number of bytes from the buffer, this is the only method which has to be implemented to fully implement the interface.
Implements plStreamWriter.
1.11.0