xiiDataDirectory::FolderReader Class Reference

Handles reading from ordinary files. More...

#include <DataDirTypeFolder.h>

Inheritance diagram for xiiDataDirectory::FolderReader:

Public Member Functions
	FolderReader (xiiInt32 iDataDirUserData)
virtual xiiUInt64	Skip (xiiUInt64 uiBytes) override
	Helper method to skip a number of bytes (implementations of the directory reader may implement this more efficiently for example)
virtual xiiUInt64	Read (void *pBuffer, xiiUInt64 uiBytes) override
virtual xiiUInt64	GetFileSize () const override
	Returns the current total size of the file.
Public Member Functions inherited from xiiDataDirectoryReader
	xiiDataDirectoryReader (xiiInt32 iDataDirUserData)
Public Member Functions inherited from xiiDataDirectoryReaderWriterBase
	xiiDataDirectoryReaderWriterBase (xiiInt32 iDataDirUserData, bool bIsReader)
	The derived class should pass along whether it is a reader or writer.
xiiResult	Open (xiiStringView sFile, xiiDataDirectoryType *pOwnerDataDirectory, xiiFileShareMode::Enum fileShareMode)
	Used by xiiDataDirectoryType's to try to open the given file. They need to pass along their own pointer.
void	Close ()
	Closes this data stream.
const xiiString128 &	GetFilePath () const
	Returns the relative path of this file within the owner data directory.
xiiDataDirectoryType *	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.
xiiInt32	GetDataDirUserData () const

Protected Member Functions
virtual xiiResult	InternalOpen (xiiFileShareMode::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
xiiOSFile	m_File
Protected Attributes inherited from xiiDataDirectoryReaderWriterBase
bool	m_bIsReader
xiiInt32	m_iDataDirUserData = 0
xiiDataDirectoryType *	m_pDataDirType
xiiString128	m_sFilePath

Friends
class	FolderType

Detailed Description

Handles reading from ordinary files.

Member Function Documentation

GetFileSize()

xiiUInt64 xiiDataDirectory::FolderReader::GetFileSize ( ) const

overridevirtual

Returns the current total size of the file.

Implements xiiDataDirectoryReaderWriterBase.

InternalClose()

void xiiDataDirectory::FolderReader::InternalClose ( )

overrideprotectedvirtual

This function must be implemented by the derived class.

Implements xiiDataDirectoryReaderWriterBase.

InternalOpen()

xiiResult xiiDataDirectory::FolderReader::InternalOpen ( xiiFileShareMode::Enum FileShareMode )

overrideprotectedvirtual

This function must be implemented by the derived class.

Implements xiiDataDirectoryReaderWriterBase.

Reimplemented in xiiDataDirectory::FileserveDataDirectoryReader.

Read()

xiiUInt64 xiiDataDirectory::FolderReader::Read ( void * pBuffer, xiiUInt64 uiBytes )

overridevirtual

Implements xiiDataDirectoryReader.

Skip()

xiiUInt64 xiiDataDirectory::FolderReader::Skip ( xiiUInt64 uiBytes )

overridevirtual

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

Reimplemented from xiiDataDirectoryReader.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/IO/FileSystem/DataDirTypeFolder.h
• /home/runner/work/XII/XII/Source/Engine/Foundation/IO/FileSystem/Implementation/DataDirTypeFolder.cpp