#include <MappedFileHandle.h>

Inheritance diagram for IMappedFileHandle:

Public Member Functions
	IMappedFileHandle (size_t InFileSize)

virtual	~IMappedFileHandle ()

UE_FORCEINLINE_HINT int64	GetFileSize () const

virtual IMappedFileRegion *	MapRegion (int64 Offset=0, int64 BytesToMap=MAX_int64, FFileMappingFlags Flags=EMappedFileFlags::ENone)=0

virtual void	Flush (void)

	IMappedFileHandle (const IMappedFileHandle &)=delete

IMappedFileHandle &	operator= (const IMappedFileHandle &)=delete

Constructor & Destructor Documentation

◆ IMappedFileHandle() [1/2]

IMappedFileHandle::IMappedFileHandle ( size_t InFileSize )

inline

◆ ~IMappedFileHandle()

virtual IMappedFileHandle::~IMappedFileHandle ( )

inlinevirtual

Destructor, also the only way to close the file handle. It is not legal to delete an async file with outstanding requests. You must always call WaitCompletion before deleting a request.

◆ IMappedFileHandle() [2/2]

IMappedFileHandle::IMappedFileHandle ( const IMappedFileHandle & )

delete

Member Function Documentation

◆ Flush()

virtual void IMappedFileHandle::Flush ( void )

inlinevirtual

◆ GetFileSize()

UE_FORCEINLINE_HINT int64 IMappedFileHandle::GetFileSize ( ) const

inline

Return the size of the mapped file.

◆ MapRegion()

virtual IMappedFileRegion * IMappedFileHandle::MapRegion	(	int64	Offset = `0`,
		int64	BytesToMap = `MAX_int64`,
		FFileMappingFlags	Flags = `EMappedFileFlags::ENone`
	)

pure virtual

Map a region of the file.

Parameters

Offset	Offset into the file to start mapping.
BytesToMap	Number of bytes to map. Clamped to the size of the file.
Flags	A combination of EMappingFlags values

Returns: the mapped region interface. Returns nullptr on failure.

Implemented in FMappedFileHandle, FUnixMappedFileHandle, FMappedFileHandleWindows, UE::IoStore::FMappedFileProxy, FMappedFileProxy, and FMappedFilePakProxy.

◆ operator=()

IMappedFileHandle & IMappedFileHandle::operator= ( const IMappedFileHandle & )