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

Classes

struct  FContainerFileAccess
 

Public Member Functions

 FIoStoreReaderImpl ()
 
UE::Tasks::FTask StartAsyncRead (int32 InPartitionIndex, int64 InPartitionOffset, int64 InReadAmount, uint8 *OutBuffer, std::atomic_bool *OutSuccess) const
 
FIoStatus Initialize (FStringView InContainerPath, const TMap< FGuid, FAES::FAESKey > &InDecryptionKeys)
 
FIoContainerId GetContainerId () const
 
uint32 GetVersion () const
 
EIoContainerFlags GetContainerFlags () const
 
FGuid GetEncryptionKeyGuid () const
 
FString GetContainerName () const
 
int32 GetChunkCount () const
 
void EnumerateChunks (TFunction< bool(FIoStoreTocChunkInfo &&)> &&Callback) const
 
TIoStatusOr< FIoStoreTocChunkInfo > GetChunkInfo (const FIoChunkId &ChunkId) const
 
TIoStatusOr< FIoStoreTocChunkInfo > GetChunkInfo (const uint32 TocEntryIndex) const
 
UE::Tasks::TTask< TIoStatusOr< FIoBuffer > > ReadAsync (const FIoChunkId &ChunkId, const FIoReadOptions &Options) const
 
TIoStatusOr< FIoBuffer > Read (const FIoChunkId &ChunkId, const FIoReadOptions &Options) const
 
TIoStatusOr< FIoStoreCompressedReadResult > ReadCompressed (const FIoChunkId &ChunkId, const FIoReadOptions &Options, bool bDecrypt) const
 
const FIoDirectoryIndexReader & GetDirectoryIndexReader () const
 
bool TocChunkContainsBlockIndex (const int32 TocEntryIndex, const int32 BlockIndex) const
 
uint32 GetCompressionBlockSize () const
 
const TArray< FName > & GetCompressionMethods () const
 
bool EnumerateCompressedBlocksForChunk (const FIoChunkId &ChunkId, TFunction< bool(const FIoStoreTocCompressedBlockInfo &)> &&Callback) const
 
void EnumerateCompressedBlocks (TFunction< bool(const FIoStoreTocCompressedBlockInfo &)> &&Callback) const
 
void GetContainerFilePaths (TArray< FString > &OutPaths)
 

Static Public Attributes

static constexpr uint32 NumHandlesPerFile = 12
 

Constructor & Destructor Documentation

◆ FIoStoreReaderImpl()

FIoStoreReaderImpl::FIoStoreReaderImpl ( )
inline

Member Function Documentation

◆ EnumerateChunks()

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

◆ EnumerateCompressedBlocks()

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

◆ EnumerateCompressedBlocksForChunk()

bool FIoStoreReaderImpl::EnumerateCompressedBlocksForChunk ( const FIoChunkId &  ChunkId,
TFunction< bool(const FIoStoreTocCompressedBlockInfo &)> &&  Callback 
) const
inline

◆ GetChunkCount()

int32 FIoStoreReaderImpl::GetChunkCount ( ) const
inline

◆ GetChunkInfo() [1/2]

TIoStatusOr< FIoStoreTocChunkInfo > FIoStoreReaderImpl::GetChunkInfo ( const FIoChunkId &  ChunkId) const
inline

◆ GetChunkInfo() [2/2]

TIoStatusOr< FIoStoreTocChunkInfo > FIoStoreReaderImpl::GetChunkInfo ( const uint32  TocEntryIndex) const
inline

◆ GetCompressionBlockSize()

uint32 FIoStoreReaderImpl::GetCompressionBlockSize ( ) const
inline

◆ GetCompressionMethods()

const TArray< FName > & FIoStoreReaderImpl::GetCompressionMethods ( ) const
inline

◆ GetContainerFilePaths()

void FIoStoreReaderImpl::GetContainerFilePaths ( TArray< FString > &  OutPaths)
inline

◆ GetContainerFlags()

EIoContainerFlags FIoStoreReaderImpl::GetContainerFlags ( ) const
inline

◆ GetContainerId()

FIoContainerId FIoStoreReaderImpl::GetContainerId ( ) const
inline

◆ GetContainerName()

FString FIoStoreReaderImpl::GetContainerName ( ) const
inline

◆ GetDirectoryIndexReader()

const FIoDirectoryIndexReader & FIoStoreReaderImpl::GetDirectoryIndexReader ( ) const
inline

◆ GetEncryptionKeyGuid()

FGuid FIoStoreReaderImpl::GetEncryptionKeyGuid ( ) const
inline

◆ GetVersion()

uint32 FIoStoreReaderImpl::GetVersion ( ) const
inline

◆ Initialize()

FIoStatus FIoStoreReaderImpl::Initialize ( FStringView  InContainerPath,
const TMap< FGuid, FAES::FAESKey > &  InDecryptionKeys 
)
inline

◆ Read()

TIoStatusOr< FIoBuffer > FIoStoreReaderImpl::Read ( const FIoChunkId &  ChunkId,
const FIoReadOptions &  Options 
) const
inline

◆ ReadAsync()

UE::Tasks::TTask< TIoStatusOr< FIoBuffer > > FIoStoreReaderImpl::ReadAsync ( const FIoChunkId &  ChunkId,
const FIoReadOptions &  Options 
) const
inline

◆ ReadCompressed()

TIoStatusOr< FIoStoreCompressedReadResult > FIoStoreReaderImpl::ReadCompressed ( const FIoChunkId &  ChunkId,
const FIoReadOptions &  Options,
bool  bDecrypt 
) const
inline

◆ StartAsyncRead()

UE::Tasks::FTask FIoStoreReaderImpl::StartAsyncRead ( int32  InPartitionIndex,
int64  InPartitionOffset,
int64  InReadAmount,
uint8 *  OutBuffer,
std::atomic_bool *  OutSuccess 
) const
inline

◆ TocChunkContainsBlockIndex()

bool FIoStoreReaderImpl::TocChunkContainsBlockIndex ( const int32  TocEntryIndex,
const int32  BlockIndex 
) const
inline

Member Data Documentation

◆ NumHandlesPerFile

constexpr uint32 FIoStoreReaderImpl::NumHandlesPerFile = 12
staticconstexpr
The documentation for this class was generated from the following file: