XII Release 0.1.0
Loading...
Searching...
No Matches
xiiFileWriterBase Class Reference

#include <FileReaderWriterBase.h>

Inheritance diagram for xiiFileWriterBase:
[legend]

Public Member Functions

xiiString128 GetFilePathAbsolute () const
 Returns the absolute path with which the file was opened (including the prefix of the data directory).
 
xiiString128 GetFilePathRelative () const
 Returns the relative path of the file within its data directory (excluding the prefix of the data directory).
 
xiiDataDirectoryTypeGetDataDirectory () const
 Returns the xiiDataDirectoryType over which this file has been opened.
 
bool IsOpen () const
 Returns true, if the file is currently open.
 
xiiUInt64 GetFileSize () const
 Returns the current total size of the file.
 
- Public Member Functions inherited from xiiStreamWriter
 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.
 

Protected Member Functions

xiiDataDirectoryWriterGetFileWriter (xiiStringView sFile, xiiFileShareMode::Enum FileShareMode, bool bAllowFileEvents)
 

Protected Attributes

xiiDataDirectoryWriterm_pDataDirWriter
 

Detailed Description

The base class for all file writers. Provides access to xiiFileSystem::GetFileWriter, which is necessary to get access to the streams that xiiDataDirectoryType's provide. Derive from this class if you want to implement different policies on how to write files. E.g. the default writer (xiiFileWriter) implements a buffered write policy (using an internal cache).


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