plDataDirectory::FolderReader Class Reference

Handles reading from ordinary files. More...

#include <DataDirTypeFolder.h>

Inheritance diagram for plDataDirectory::FolderReader:

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

Protected Member Functions
virtual plResult	InternalOpen (plFileShareMode::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
plOSFile	m_File
Protected Attributes inherited from plDataDirectoryReaderWriterBase
bool	m_bIsReader
plInt32	m_iDataDirUserData = 0
plDataDirectoryType *	m_pDataDirType
plString128	m_sFilePath

Friends
class	FolderType

Detailed Description

Handles reading from ordinary files.

Member Function Documentation

GetFileSize()

plUInt64 plDataDirectory::FolderReader::GetFileSize ( ) const

overridevirtual

Returns the current total size of the file.

Implements plDataDirectoryReaderWriterBase.

InternalClose()

void plDataDirectory::FolderReader::InternalClose ( )

overrideprotectedvirtual

This function must be implemented by the derived class.

Implements plDataDirectoryReaderWriterBase.

InternalOpen()

plResult plDataDirectory::FolderReader::InternalOpen ( plFileShareMode::Enum FileShareMode )

overrideprotectedvirtual

This function must be implemented by the derived class.

Implements plDataDirectoryReaderWriterBase.

Reimplemented in plDataDirectory::FileserveDataDirectoryReader.

Read()

plUInt64 plDataDirectory::FolderReader::Read ( void * pBuffer, plUInt64 uiBytes )

overridevirtual

Implements plDataDirectoryReader.

Skip()

plUInt64 plDataDirectory::FolderReader::Skip ( plUInt64 uiBytes )

overridevirtual

Helper method to skip a number of bytes (implementations of the directory reader may implement this more efficiently for example)

Reimplemented from plDataDirectoryReader.

---

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

• Code/Engine/Foundation/IO/FileSystem/DataDirTypeFolder.h
• Code/Engine/Foundation/IO/FileSystem/Implementation/DataDirTypeFolder.cpp