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

Inheritance diagram for plDataDirectoryWriter:

[legend]

Public Member Functions
	plDataDirectoryWriter (plInt32 iDataDirUserData)

virtual plResult	Write (const void *pBuffer, plUInt64 uiBytes)=0

Public Member Functions inherited from plDataDirectoryReaderWriterBase
	plDataDirectoryReaderWriterBase (plInt32 iDataDirUserData, bool bIsReader)
	The derived class should pass along whether it is a reader or writer.

plResult	Open (plStringView sFile, plDataDirectoryType *pOwnerDataDirectory, plFileShareMode::Enum fileShareMode)
	Used by plDataDirectoryType's to try to open the given file. They need to pass along their own pointer.

void	Close ()
	Closes this data stream.

const plString128 &	GetFilePath () const
	Returns the relative path of this file within the owner data directory.

plDataDirectoryType *	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.

virtual plUInt64	GetFileSize () const =0
	Returns the current total size of the file.

plInt32	GetDataDirUserData () const

Additional Inherited Members
Protected Member Functions inherited from plDataDirectoryReaderWriterBase
virtual plResult	InternalOpen (plFileShareMode::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 plDataDirectoryReaderWriterBase
bool	m_bIsReader

plInt32	m_iDataDirUserData = 0

plDataDirectoryType *	m_pDataDirType

plString128	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:

Public Member Functions