IO

Choose your operating system:

Windows

macOS

Linux

Classes

Name

Description

Public struct

FFilePackageStoreEntry

File based package store entry

Public class

FIoBatch

I/O batch

This is a primitive used to group I/O requests for synchronization purposes

Public class

FIoBuffer

Reference to buffer data used by I/O dispatcher APIs

Public class

FIoChunkHash

Public class

FIoChunkId

Identifier to a chunk of data.

Public struct

FIoContainerHeader

Public struct

FIoContainerHeaderLocalizedPackage

Public struct

FIoContainerHeaderPackageRedirect

Public class

FIoContainerId

Container ID.

Public struct

FIoContainerSettings

Public class

FIoDirectoryIndexHandle

Public class

FIoDirectoryIndexReader

Public class

FIoDispatcher

I/O dispatcher

Public struct

FIoDispatcherBackendContext

Public struct

FIoDispatcherMountedContainer

Public struct

FIoHash

Stores a BLAKE3-160 hash, taken from the first 20 bytes of a BLAKE3-256 hash.

Public class

FIoHashBuilder

Calculates a BLAKE3-160 hash.

Public struct

FIoMappedRegion

Mapped region.

Public class

FIoReadOptions

Public class

FIoRequest

Public class

FIoRequestImpl

Public struct

FIoSignatureError

Public struct

FIoSignatureErrorEvent

Public class

FIoStatus

I/O status with error code and message.

Public class

FIoStatusBuilder

Helper to make it easier to generate meaningful error messages.

Public struct

FIoStoreCompressedBlockInfo

Public struct

FIoStoreCompressedReadResult

Public class

FIoStoreEnvironment

Helper used to manage creation of I/O store file handles etc

Public class

FIoStoreReader

Public struct

FIoStoreTocChunkInfo

Public struct

FIoStoreTocCompressedBlockInfo

Public class

FIoStoreWriterContext

Public struct

FIoStoreWriterResult

Public struct

FIoStoreWriterSettings

Public struct

FIoWriteOptions

Public class

FPackageId

Public class

FPackageStoreBase

Public struct

FPackageStoreEntry

Package store entry.

Public struct

FPackageStoreEntryResource

Package store entry resource.

Public struct

FPackageStoreExportInfo

Package export information.

Public struct

IIoDispatcherBackend

Public class

IIoStoreWriter

Public class

IIoStoreWriteRequest

Public class

IPackageStore

Stores information about available packages that can be loaded.

Public class

TFilePackageStoreEntryCArrayView

Package store entry array view.

Public class

TIoStatusOr

Optional I/O result or error status.

Typedefs

Enums

Name

Description

Public enum

EIoChunkType

Addressable chunk types.

Public enum

EIoContainerFlags

Public enum

EIoContainerHeaderVersion

Public enum

EIoDispatcherPriority

Public enum

EIoErrorCode

I/O error code.

Public enum

EPackageStoreEntryFlags

Package store entry flags.

Public enum

EPackageStoreEntryStatus

Package store entry status.

Functions

Name Description

Public function

int32

 

ConvertToIoDispatcherPriority

(
    EAsyncIOPriorityAndFlags AIOP
)

Public function

FIoChunkId

 

CreateExternalFileChunkId

(
    const FStringView Filename
)

Public function Static

FIoChunkId

 

CreateIoChunkId

(
    uint64 ChunkId,
    uint16 ChunkIndex,
    EIoChunkType IoChunkType
)

Creates a chunk identifier (generic prefer specialized versions where possible)

Public function Static

const TCHAR ...

 

GetIoErrorText

(
    EIoErrorCode ErrorCode
)

Get I/O error code description.

Public function

uint32

 

GetTypeHash

(
    const FIoHash& Hash
)

Public function

void

 

LexFromString

(
    FIoHash& OutHash,
    const TCHAR* Buffer
)

Construct a hash from a 40-character hex string.

Public function

FString

 

LexToString

(
    const EIoChunkType Type
)

Public function

FString

 

LexToString

(
    const FIoHash& Hash
)

Convert a hash to a 40-character hex string.

Public function

constexpr bo...

 

operator!

(
    EPackageStoreEntryFlags E
)

Public function

constexpr bo...

 

operator!

(
    EIoContainerFlags E
)

Public function

bool

 

operator!=

(
    const FIoHash& A,
    const FIoHash& B
)

Public function

constexpr EP...

 

operator&

(
    EPackageStoreEntryFlags Lhs,
    EPackageStoreEntryFlags Rhs
)

Public function

constexpr EI...

 

operator&

(
    EIoContainerFlags Lhs,
    EIoContainerFlags Rhs
)

Public function

EIoContainer...

 

operator&=

(
    EIoContainerFlags& Lhs,
    EIoContainerFlags Rhs
)

Public function

EPackageStor...

 

operator&=

(
    EPackageStoreEntryFlags& Lhs,
    EPackageStoreEntryFlags Rhs
)

Public function

constexpr EI...

 

operator^

(
    EIoContainerFlags Lhs,
    EIoContainerFlags Rhs
)

Public function

constexpr EP...

 

operator^

(
    EPackageStoreEntryFlags Lhs,
    EPackageStoreEntryFlags Rhs
)

Public function

EIoContainer...

 

operator^=

(
    EIoContainerFlags& Lhs,
    EIoContainerFlags Rhs
)

Public function

EPackageStor...

 

operator^=

(
    EPackageStoreEntryFlags& Lhs,
    EPackageStoreEntryFlags Rhs
)

Public function

constexpr EI...

 

operator|

(
    EIoContainerFlags Lhs,
    EIoContainerFlags Rhs
)

Public function

constexpr EP...

 

operator|

(
    EPackageStoreEntryFlags Lhs,
    EPackageStoreEntryFlags Rhs
)

Public function

EIoContainer...

 

operator|=

(
    EIoContainerFlags& Lhs,
    EIoContainerFlags Rhs
)

Public function

EPackageStor...

 

operator|=

(
    EPackageStoreEntryFlags& Lhs,
    EPackageStoreEntryFlags Rhs
)

Public function

constexpr EI...

 

operator~

(
    EIoContainerFlags E
)

Public function

constexpr EP...

 

operator~

(
    EPackageStoreEntryFlags E
)

Public function

bool

 

operator==

(
    const FIoHash& A,
    const FIoHash& B
)

Public function

void

 

StatusOrCrash

(
    const FIoStatus& Status
)