Plasma Engine  2.0
Loading...
Searching...
No Matches
plDataDirectory::ArchiveReaderCommon Class Reference
Inheritance diagram for plDataDirectory::ArchiveReaderCommon:

Public Member Functions

 ArchiveReaderCommon (plInt32 iDataDirUserData)
 
virtual plUInt64 GetFileSize () const override
 Returns the current total size of the file.
 
- Public Member Functions inherited from plDataDirectoryReader
 plDataDirectoryReader (plInt32 iDataDirUserData)
 
virtual plUInt64 Read (void *pBuffer, plUInt64 uiBytes)=0
 
virtual plUInt64 Skip (plUInt64 uiBytes)
 Helper method to skip a number of bytes (implementations of the directory reader may implement this more efficiently for example)
 
- 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 plString128GetFilePath () const
 Returns the relative path of this file within the owner data directory.
 
plDataDirectoryTypeGetDataDirectory () 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.
 
plInt32 GetDataDirUserData () const
 

Protected Attributes

plUInt64 m_uiUncompressedSize = 0
 
plUInt64 m_uiCompressedSize = 0
 
plRawMemoryStreamReader m_MemStreamReader
 
- Protected Attributes inherited from plDataDirectoryReaderWriterBase
bool m_bIsReader
 
plInt32 m_iDataDirUserData = 0
 
plDataDirectoryTypem_pDataDirType
 
plString128 m_sFilePath
 

Friends

class ArchiveType
 

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.
 

Member Function Documentation

◆ GetFileSize()

plUInt64 plDataDirectory::ArchiveReaderCommon::GetFileSize ( ) const
overridevirtual

Returns the current total size of the file.

Implements plDataDirectoryReaderWriterBase.


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