Navigation
API > API/Runtime > API/Runtime/Core
The I/O store reader provides non-runtime convenience functionality for reading I/O store container files.
| Name | FIoStoreReader |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/IO/IoDispatcher.h |
| Include Path | #include "IO/IoDispatcher.h" |
Syntax
class FIoStoreReader
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FIoStoreReader() |
IO/IoDispatcher.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FIoStoreReader() |
IO/IoDispatcher.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Impl | FIoStoreReaderImpl * | IO/IoDispatcher.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EnumerateChunks
(
TFunction< bool(FIoStoreTocChunkInfo&&)>&& Callback |
IO/IoDispatcher.h | ||
void EnumerateCompressedBlocks
(
TFunction< bool(const FIoStoreTocCompressedBlockInfo&)>&& Callback |
IO/IoDispatcher.h | ||
void EnumerateCompressedBlocksForChunk
(
const FIoChunkId& Chunk, |
IO/IoDispatcher.h | ||
int32 GetChunkCount() |
IO/IoDispatcher.h | ||
TIoStatusOr< FIoStoreTocChunkInfo > GetChunkInfo
(
const FIoChunkId& Chunk |
IO/IoDispatcher.h | ||
TIoStatusOr< FIoStoreTocChunkInfo > GetChunkInfo
(
const uint32 TocEntryIndex |
IO/IoDispatcher.h | ||
uint32 GetCompressionBlockSize() |
IO/IoDispatcher.h | ||
| IO/IoDispatcher.h | |||
| Returns the .ucas file path and all partition(s) ({containername}_s1.ucas, {containername}_s2.ucas) | IO/IoDispatcher.h | ||
EIoContainerFlags GetContainerFlags() |
IO/IoDispatcher.h | ||
FIoContainerId GetContainerId() |
IO/IoDispatcher.h | ||
FString GetContainerName() |
IO/IoDispatcher.h | ||
const FIoDirectoryIndexReader & GetDirectoryIndexReader() |
IO/IoDispatcher.h | ||
FGuid GetEncryptionKeyGuid() |
IO/IoDispatcher.h | ||
| IO/IoDispatcher.h | |||
| IO/IoDispatcher.h | |||
uint64 GetPartitionSize() |
IO/IoDispatcher.h | ||
uint32 GetVersion() |
IO/IoDispatcher.h | ||
FIoStatus Initialize
(
FStringView ContainerPath, |
IO/IoDispatcher.h | ||
TIoStatusOr< FIoBuffer > Read
(
const FIoChunkId& Chunk, |
Reads the chunk off the disk, decrypting/decompressing as necessary. | IO/IoDispatcher.h | |
UE::Tasks::TTask< TIoStatusOr< FIoBuffer > > ReadAsync
(
const FIoChunkId& Chunk, |
As Read(), except returns a task that will contain the result after a .Wait/.BusyWait. | IO/IoDispatcher.h | |
TIoStatusOr< FIoStoreCompressedReadResult > ReadCompressed
(
const FIoChunkId& Chunk, |
Reads and decrypts if necessary the compressed blocks, but does not decompress them. | IO/IoDispatcher.h |