IO

API > API/Runtime > API/Runtime/Core

Classes

  Type Name Description
Public struct FFilePackageStoreEntry File based package store entry  
Public class FIoBatch I/O batchThis 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 struct FIoChunkDecodingParams Parameters for decoding a set of encoded blocks(s).  
Public class FIoChunkEncoding Encodes data into a set of encrypted and compressed blocks.  
Public struct FIoChunkEncodingParams Defines how the I/O chunk gets encoded into a set of compressed and encrypted block(s).  
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 FIoStoreCompressedChunkInfo    
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 FPackageStore Stores information about available packages that can be loaded.  
Public class FPackageStoreBackendContext    
Public struct FPackageStoreEntry Package store entry.  
Public struct FPackageStoreEntryResource Package store entry resource.  
Public class FPackageStoreReadScope    
Public struct IIoDispatcherBackend    
Public class IIoStoreWriter    
Public class IIoStoreWriteRequest    
Public class IIoStoreWriterHashDatabase Allows the IIoStoreWriter to avoid loading and hashing chunks, saving pak/stage time, as the normal process involved loading the chunks, hashing them, freeing them, making some decisions, then loading them again for compression/writting.  
Public class IIoStoreWriterReferenceChunkDatabase    
Public class IPackageStore Stores information about available packages that can be loaded.  
Public class IPackageStoreBackend Package store backend interface.  
Public class PRAGMA_DISABLE_DEPRECATION_WARNINGS    
Public class TFilePackageStoreEntryCArrayView Package store entry array view.  
Public class TIoStatusOr Optional I/O result or error status.  

Typedefs

Name Description
FDirectoryIndexVisitorFunction  
FIoBlockHash  
FIoContainerMountedDelegate  
FIoReadCallback  
FIoSignatureErrorDelegate  
FWakeUpIoDispatcherThreadDelegate  

Enums

  Type Name Description
Public enum EIoChunkType Addressable chunk types.  
Public enum EIoContainerFlags    
Public enum EIoContainerHeaderVersion    
Public enum EIoDispatcherPriority    
Public enum EIoEncryptionMethod I/O chunk encryption method.  
Public enum EIoErrorCode I/O error code.  
Public enum EPackageStoreEntryFlags Package store entry flags.  
Public enum EPackageStoreEntryStatus Package store entry status.  

Functions

  Type Name Description
Public function int32  
Public function FIoChunkId Returns a file data I/O chunk ID for the specified filename.
Public function FIoChunkId

CreateIoChunkId ( uint64 ChunkId,
uint16 ChunkIndex,
EIoChunkType IoChunkType
)

 Creates a chunk identifier (generic prefer specialized versions where possible).
Public function FIoChunkId

CreatePackageDataChunkId ( const FPackageId& PackageId
)

 Returns a package data I/O chunk ID for the specified package ID.
Public function const TCHAR * Get I/O error code description.
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 bool  
Public function bool  
Public function EIoContainerFlags  
Public function EPackageStoreEntryFlags  
Public function EIoContainerFlags &  
Public function EPackageStoreEntryFlags &  
Public function EIoContainerFlags  
Public function EPackageStoreEntryFlags  
Public function EIoContainerFlags &  
Public function EPackageStoreEntryFlags &  
Public function EIoContainerFlags  
Public function EPackageStoreEntryFlags  
Public function EIoContainerFlags &  
Public function EPackageStoreEntryFlags &  
Public function EIoContainerFlags  
Public function EPackageStoreEntryFlags  
Public function void

StatusOrCrash ( const FIoStatus& Status
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page