UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::FIoPlatformReadRequest Struct Reference

#include <PlatformIoDispatcherBase.h>

+ Inheritance diagram for UE::FIoPlatformReadRequest:

Classes

struct  FDirectRead
 
struct  FScatterGather
 

Public Types

enum class  EType : uint8 { ScatterGather , DirectRead }
 
- Public Types inherited from TIntrusiveListElement< FIoPlatformReadRequest >
using ElementType = FIoPlatformReadRequest
 

Public Member Functions

 FIoPlatformReadRequest (FIoFileReadRequestCompleted &&InOnCompleted, FIoBuffer &InDst, uint64 InDstSize, void *InUserData, uint32 InFileId)
 
 FIoPlatformReadRequest (FIoFileReadRequestCompleted &&InOnCompleted, FIoBuffer &InDst, uint64 InDstSize, uint64 InFileOffset, void *InUserData)
 
bool IsScatterGather () const
 
bool IsDirectRead () const
 
- Public Member Functions inherited from UE::FInheritedContextBase
void CaptureInheritedContext ()
 
CORE_API FInheritedContextScope RestoreInheritedContext ()
 

Public Attributes

FIoFileReadRequestCompleted OnCompleted
 
union { 
 
   FScatterGather   ScatterGather 
 
   FDirectRead   DirectRead 
 
};  
 
FIoPlatformReadRequestNext = nullptr
 
FIoBufferDst
 
uint64 DstSize = 0
 
voidUserData = nullptr
 
uint32 RefCount = 1
 
uint32 FailedBlockId = MAX_uint32
 
std::atomic< EIoErrorCodeErrorCode {EIoErrorCode::Ok}
 
EType Type = EType::ScatterGather
 

Additional Inherited Members

- Static Public Member Functions inherited from TIntrusiveListElement< FIoPlatformReadRequest >
static FIoPlatformReadRequest * GetNext (const ElementType *Element)
 
static void SetNext (ElementType *Element, ElementType *Next)
 

Member Enumeration Documentation

◆ EType

Enumerator
ScatterGather 
DirectRead 

Constructor & Destructor Documentation

◆ FIoPlatformReadRequest() [1/2]

UE::FIoPlatformReadRequest::FIoPlatformReadRequest ( FIoFileReadRequestCompleted &&  InOnCompleted,
FIoBuffer InDst,
uint64  InDstSize,
void InUserData,
uint32  InFileId 
)
inline

◆ FIoPlatformReadRequest() [2/2]

UE::FIoPlatformReadRequest::FIoPlatformReadRequest ( FIoFileReadRequestCompleted &&  InOnCompleted,
FIoBuffer InDst,
uint64  InDstSize,
uint64  InFileOffset,
void InUserData 
)
inline

Member Function Documentation

◆ IsDirectRead()

bool UE::FIoPlatformReadRequest::IsDirectRead ( ) const
inline

◆ IsScatterGather()

bool UE::FIoPlatformReadRequest::IsScatterGather ( ) const
inline

Member Data Documentation

◆ [union]

◆ DirectRead

FDirectRead UE::FIoPlatformReadRequest::DirectRead

◆ Dst

FIoBuffer& UE::FIoPlatformReadRequest::Dst

◆ DstSize

uint64 UE::FIoPlatformReadRequest::DstSize = 0

◆ ErrorCode

std::atomic<EIoErrorCode> UE::FIoPlatformReadRequest::ErrorCode {EIoErrorCode::Ok}

◆ FailedBlockId

uint32 UE::FIoPlatformReadRequest::FailedBlockId = MAX_uint32

◆ Next

FIoPlatformReadRequest* UE::FIoPlatformReadRequest::Next = nullptr

◆ OnCompleted

FIoFileReadRequestCompleted UE::FIoPlatformReadRequest::OnCompleted

◆ RefCount

uint32 UE::FIoPlatformReadRequest::RefCount = 1

◆ ScatterGather

FScatterGather UE::FIoPlatformReadRequest::ScatterGather

◆ Type

EType UE::FIoPlatformReadRequest::Type = EType::ScatterGather

◆ UserData

void* UE::FIoPlatformReadRequest::UserData = nullptr

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