ezEngine  Release 25.03
ezDataDirectoryWriter Class Referenceabstract

A base class for writers that handle writing to a (virtual) file inside a data directory. More...

#include <DataDirType.h>

Inheritance diagram for ezDataDirectoryWriter:

Public Member Functions

 ezDataDirectoryWriter (ezInt32 iDataDirUserData)
 
virtual ezResult Write (const void *pBuffer, ezUInt64 uiBytes)=0
 
- Public Member Functions inherited from ezDataDirectoryReaderWriterBase
 ezDataDirectoryReaderWriterBase (ezInt32 iDataDirUserData, bool bIsReader)
 The derived class should pass along whether it is a reader or writer.
 
ezResult Open (ezStringView sFile, ezDataDirectoryType *pOwnerDataDirectory, ezFileShareMode::Enum fileShareMode)
 Used by ezDataDirectoryType's to try to open the given file. They need to pass along their own pointer.
 
void Close ()
 Closes this data stream.
 
const ezString128GetFilePath () const
 Returns the relative path of this file within the owner data directory.
 
ezDataDirectoryTypeGetDataDirectory () const
 Returns the pointer to the data directory, which created this reader/writer.
 
bool IsReader () const
 Returns true if this is a reader stream, false if it is a writer stream.
 
virtual ezUInt64 GetFileSize () const =0
 Returns the current total size of the file.
 
ezInt32 GetDataDirUserData () const
 

Additional Inherited Members

- Protected Member Functions inherited from ezDataDirectoryReaderWriterBase
virtual ezResult InternalOpen (ezFileShareMode::Enum FileShareMode)=0
 This function must be implemented by the derived class.
 
virtual void InternalClose ()=0
 This function must be implemented by the derived class.
 
- Protected Attributes inherited from ezDataDirectoryReaderWriterBase
bool m_bIsReader
 
ezInt32 m_iDataDirUserData = 0
 
ezDataDirectoryTypem_pDataDirType
 
ezString128 m_sFilePath
 

Detailed Description

A base class for writers that handle writing to a (virtual) file inside a data directory.

Different data directory types (ZIP file, simple folder, etc.) use different reader/writer types.


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