UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::BulkData::Private::FChunkReadFileHandle Class Reference
+ Inheritance diagram for UE::BulkData::Private::FChunkReadFileHandle:

Public Member Functions

 FChunkReadFileHandle (const FIoChunkId &InChunkId, const FIoOffsetAndLength &InChunkRange, uint64 InChunkSize, uint64 InAvailableChunkSize)
 
virtual ~FChunkReadFileHandle ()=default
 
virtual IAsyncReadRequestSizeRequest (FAsyncFileCallBack *CompleteCallback=nullptr) override
 
virtual IAsyncReadRequestReadRequest (int64 Offset, int64 BytesToRead, EAsyncIOPriorityAndFlags PriorityAndFlags=AIOP_Normal, FAsyncFileCallBack *CompleteCallback=nullptr, uint8 *UserSuppliedMemory=nullptr) override
 
- Public Member Functions inherited from IAsyncReadFileHandle
 IAsyncReadFileHandle ()
 
virtual ~IAsyncReadFileHandle ()
 
virtual bool UsesCache ()
 
virtual void ShrinkHandleBuffers ()
 
 IAsyncReadFileHandle (const IAsyncReadFileHandle &)=delete
 
IAsyncReadFileHandleoperator= (const IAsyncReadFileHandle &)=delete
 

Constructor & Destructor Documentation

◆ FChunkReadFileHandle()

UE::BulkData::Private::FChunkReadFileHandle::FChunkReadFileHandle ( const FIoChunkId InChunkId,
const FIoOffsetAndLength InChunkRange,
uint64  InChunkSize,
uint64  InAvailableChunkSize 
)
inline

◆ ~FChunkReadFileHandle()

virtual UE::BulkData::Private::FChunkReadFileHandle::~FChunkReadFileHandle ( )
virtualdefault

Member Function Documentation

◆ ReadRequest()

IAsyncReadRequest * UE::BulkData::Private::FChunkReadFileHandle::ReadRequest ( int64  Offset,
int64  BytesToRead,
EAsyncIOPriorityAndFlags  PriorityAndFlags = AIOP_Normal,
FAsyncFileCallBack CompleteCallback = nullptr,
uint8 UserSuppliedMemory = nullptr 
)
overridevirtual

Submit an async request and/or wait for an async request

Parameters
OffsetOffset into the file to start reading.
BytesToReadnumber of bytes to read. If this request is AIOP_Preache, the size can be anything, even MAX_int64, otherwise the size and offset must be fully contained in the file.
PriorityAndFlagsPriority and flags of the request. If this includes AIOP_FLAG_PRECACHE, then memory will never be returned. The request should always be canceled and waited for, even for a precache request.
CompleteCallbackCalled from an arbitrary thread when the request is complete. Can be nullptr, if non-null, must remain valid until it is called. It will always be called.
Returns
A request for the read. This is owned by the caller and must be deleted by the caller.

Implements IAsyncReadFileHandle.

◆ SizeRequest()

IAsyncReadRequest * UE::BulkData::Private::FChunkReadFileHandle::SizeRequest ( FAsyncFileCallBack CompleteCallback = nullptr)
overridevirtual

Request the size of the file. This is also essentially the existence check.

Parameters
CompleteCallbackCalled from an arbitrary thread when the request is complete. Can be nullptr, if non-null, must remain valid until it is called. It will always be called.
Returns
A request for the size. This is owned by the caller and must be deleted by the caller.

Implements IAsyncReadFileHandle.


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