UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FIoStoreReader Class Reference

#include <IoDispatcher.h>

Public Member Functions

CORE_API FIoStoreReader ()
 
CORE_API ~FIoStoreReader ()
 
CORE_API FIoStatus Initialize (FStringView ContainerPath, const TMap< FGuid, FAES::FAESKey > &InDecryptionKeys)
 
CORE_API FIoContainerId GetContainerId () const
 
CORE_API uint32 GetVersion () const
 
CORE_API EIoContainerFlags GetContainerFlags () const
 
CORE_API FGuid GetEncryptionKeyGuid () const
 
CORE_API int32 GetChunkCount () const
 
CORE_API FString GetContainerName () const
 
CORE_API void EnumerateChunks (TFunction< bool(FIoStoreTocChunkInfo &&)> &&Callback) const
 
CORE_API TIoStatusOr< FIoStoreTocChunkInfo > GetChunkInfo (const FIoChunkId &Chunk) const
 
CORE_API TIoStatusOr< FIoStoreTocChunkInfo > GetChunkInfo (const uint32 TocEntryIndex) const
 
CORE_API TIoStatusOr< FIoBuffer > Read (const FIoChunkId &Chunk, const FIoReadOptions &Options) const
 
CORE_API UE::Tasks::TTask< TIoStatusOr< FIoBuffer > > ReadAsync (const FIoChunkId &Chunk, const FIoReadOptions &Options) const
 
CORE_API TIoStatusOr< FIoStoreCompressedReadResult > ReadCompressed (const FIoChunkId &Chunk, const FIoReadOptions &Options, bool bDecrypt=true) const
 
CORE_API const FIoDirectoryIndexReader & GetDirectoryIndexReader () const
 
CORE_API void GetFilenamesByBlockIndex (const TArray< int32 > &InBlockIndexList, TArray< FString > &OutFileList) const
 
CORE_API void GetFilenames (TArray< FString > &OutFileList) const
 
CORE_API uint32 GetCompressionBlockSize () const
 
CORE_API const TArray< FName > & GetCompressionMethods () const
 
CORE_API void EnumerateCompressedBlocks (TFunction< bool(const FIoStoreTocCompressedBlockInfo &)> &&Callback) const
 
CORE_API void EnumerateCompressedBlocksForChunk (const FIoChunkId &Chunk, TFunction< bool(const FIoStoreTocCompressedBlockInfo &)> &&Callback) const
 
CORE_API void GetContainerFilePaths (TArray< FString > &OutPaths)
 

Constructor & Destructor Documentation

◆ FIoStoreReader()

FIoStoreReader::FIoStoreReader ( )

◆ ~FIoStoreReader()

FIoStoreReader::~FIoStoreReader ( )

Member Function Documentation

◆ EnumerateChunks()

void FIoStoreReader::EnumerateChunks ( TFunction< bool(FIoStoreTocChunkInfo &&)> &&  Callback) const

◆ EnumerateCompressedBlocks()

void FIoStoreReader::EnumerateCompressedBlocks ( TFunction< bool(const FIoStoreTocCompressedBlockInfo &)> &&  Callback) const

◆ EnumerateCompressedBlocksForChunk()

void FIoStoreReader::EnumerateCompressedBlocksForChunk ( const FIoChunkId &  Chunk,
TFunction< bool(const FIoStoreTocCompressedBlockInfo &)> &&  Callback 
) const

◆ GetChunkCount()

int32 FIoStoreReader::GetChunkCount ( ) const

◆ GetChunkInfo() [1/2]

TIoStatusOr< FIoStoreTocChunkInfo > FIoStoreReader::GetChunkInfo ( const FIoChunkId &  Chunk) const

◆ GetChunkInfo() [2/2]

TIoStatusOr< FIoStoreTocChunkInfo > FIoStoreReader::GetChunkInfo ( const uint32  TocEntryIndex) const

◆ GetCompressionBlockSize()

uint32 FIoStoreReader::GetCompressionBlockSize ( ) const

◆ GetCompressionMethods()

const TArray< FName > & FIoStoreReader::GetCompressionMethods ( ) const

◆ GetContainerFilePaths()

void FIoStoreReader::GetContainerFilePaths ( TArray< FString > &  OutPaths)

◆ GetContainerFlags()

EIoContainerFlags FIoStoreReader::GetContainerFlags ( ) const

◆ GetContainerId()

FIoContainerId FIoStoreReader::GetContainerId ( ) const

◆ GetContainerName()

FString FIoStoreReader::GetContainerName ( ) const

◆ GetDirectoryIndexReader()

const FIoDirectoryIndexReader & FIoStoreReader::GetDirectoryIndexReader ( ) const

◆ GetEncryptionKeyGuid()

FGuid FIoStoreReader::GetEncryptionKeyGuid ( ) const

◆ GetFilenames()

void FIoStoreReader::GetFilenames ( TArray< FString > &  OutFileList) const

◆ GetFilenamesByBlockIndex()

void FIoStoreReader::GetFilenamesByBlockIndex ( const TArray< int32 > &  InBlockIndexList,
TArray< FString > &  OutFileList 
) const

◆ GetVersion()

uint32 FIoStoreReader::GetVersion ( ) const

◆ Initialize()

FIoStatus FIoStoreReader::Initialize ( FStringView  ContainerPath,
const TMap< FGuid, FAES::FAESKey > &  InDecryptionKeys 
)

◆ Read()

TIoStatusOr< FIoBuffer > FIoStoreReader::Read ( const FIoChunkId &  Chunk,
const FIoReadOptions &  Options 
) const

◆ ReadAsync()

UE::Tasks::TTask< TIoStatusOr< FIoBuffer > > FIoStoreReader::ReadAsync ( const FIoChunkId &  Chunk,
const FIoReadOptions &  Options 
) const

◆ ReadCompressed()

TIoStatusOr< FIoStoreCompressedReadResult > FIoStoreReader::ReadCompressed ( const FIoChunkId &  Chunk,
const FIoReadOptions &  Options,
bool  bDecrypt = true 
) const
The documentation for this class was generated from the following files: