xiiDeferredFileWriter Class Reference

Copyright (c) Theophilus Eriata. All Rights Reserved. More...

#include <DeferredFileWriter.h>

Inheritance diagram for xiiDeferredFileWriter:

Public Member Functions
	xiiDeferredFileWriter ()
	Copyright (c) Theophilus Eriata. All Rights Reserved.
	~xiiDeferredFileWriter ()
	Upon destruction the file is closed and thus written, unless Discard was called before.
void	SetOutput (xiiStringView sFileToWriteTo, bool bOnlyWriteIfDifferent=false)
	This must be configured before anything is written to the file.
virtual xiiResult	WriteBytes (const void *pWriteBuffer, xiiUInt64 uiBytesToWrite) override
xiiResult	Close (bool *out_pWasWrittenTo=nullptr)
void	Discard ()
Public Member Functions inherited from xiiStreamWriter
	xiiStreamWriter ()
	Constructor.
virtual	~xiiStreamWriter ()
	Virtual destructor to ensure correct cleanup.
virtual xiiResult	Flush ()
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

Copyright (c) Theophilus Eriata. All Rights Reserved.

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.

Member Function Documentation

Close()

xiiResult xiiDeferredFileWriter::Close

(

bool *

out_pWasWrittenTo = nullptr

)

Upon calling this the content is written to the file specified with SetOutput(). The return value is XII_FAILURE if the file could not be opened or not completely written.

Discard()

void xiiDeferredFileWriter::Discard

(

)

Calling this abandons the content and a later Close or destruction of the instance will no longer write anything to file.

WriteBytes()

xiiResult xiiDeferredFileWriter::WriteBytes ( const void * pWriteBuffer, xiiUInt64 uiBytesToWrite )

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 xiiStreamWriter.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/IO/FileSystem/DeferredFileWriter.h
• /home/runner/work/XII/XII/Source/Engine/Foundation/IO/FileSystem/Implementation/DeferredFileWriter.cpp