ezEngine Release 26.9
Loading...
Searching...
No Matches
ezDataDirectory::FolderWriter Class Reference

Handles writing to ordinary files. More...

#include <DataDirTypeFolder.h>

Inheritance diagram for ezDataDirectory::FolderWriter:

Public Member Functions

 FolderWriter (ezInt32 iDataDirUserData=0)
 
virtual ezResult Write (const void *pBuffer, ezUInt64 uiBytes) override
 
virtual ezUInt64 GetFileSize () const override
 Returns the current total size of the file.
 
- Public Member Functions inherited from ezDataDirectoryWriter
 ezDataDirectoryWriter (ezInt32 iDataDirUserData)
 
- 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 ezString128 & GetFilePath () const
 Returns the relative path of this file within the owner data directory.
 
ezDataDirectoryType * GetDataDirectory () 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.
 
ezInt32 GetDataDirUserData () const
 

Protected Member Functions

virtual ezResult InternalOpen (ezFileShareMode::Enum FileShareMode) override
 This function must be implemented by the derived class.
 
virtual void InternalClose () override
 This function must be implemented by the derived class.
 

Protected Attributes

bool m_bIsInUse
 
ezOSFile m_File
 
- Protected Attributes inherited from ezDataDirectoryReaderWriterBase
bool m_bIsReader
 
ezInt32 m_iDataDirUserData = 0
 
ezDataDirectoryType * m_pDataDirType
 
ezString128 m_sFilePath
 

Friends

class FolderType
 

Detailed Description

Handles writing to ordinary files.

Member Function Documentation

◆ GetFileSize()

ezUInt64 ezDataDirectory::FolderWriter::GetFileSize ( ) const
overridevirtual

Returns the current total size of the file.

Implements ezDataDirectoryReaderWriterBase.

◆ InternalClose()

void ezDataDirectory::FolderWriter::InternalClose ( )
overrideprotectedvirtual

This function must be implemented by the derived class.

Implements ezDataDirectoryReaderWriterBase.

Reimplemented in ezDataDirectory::FileserveDataDirectoryWriter.

◆ InternalOpen()

ezResult ezDataDirectory::FolderWriter::InternalOpen ( ezFileShareMode::Enum  FileShareMode)
overrideprotectedvirtual

This function must be implemented by the derived class.

Implements ezDataDirectoryReaderWriterBase.

◆ Write()

ezResult ezDataDirectory::FolderWriter::Write ( const void *  pBuffer,
ezUInt64  uiBytes 
)
overridevirtual

Implements ezDataDirectoryWriter.


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