UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
OnDemandError.h File Reference

Go to the source code of this file.

Classes

struct  UE::UnifiedError::IoStoreOnDemand::FCasErrorContext
 
struct  UE::UnifiedError::IoStoreOnDemand::FChunkMissingErrorContext
 
struct  UE::UnifiedError::IoStoreOnDemand::FChunkHashMismatchErrorContext
 
struct  UE::UnifiedError::IoStoreOnDemand::FInstallCacheErrorContext
 
struct  UE::UnifiedError::IoStoreOnDemand::FVerificationErrorContext
 

Namespaces

namespace  UE
 
namespace  UE::IoStore
 NO_LOGGING.
 
namespace  UE::UnifiedError
 
namespace  UE::UnifiedError::IoStoreOnDemand
 

Macros

#define UE_API   IOSTOREONDEMANDCORE_API
 

Typedefs

using UE::IoStore::FResult = TValueOrError< void, UE::UnifiedError::FError >
 
template<typename ResultType >
using UE::IoStore::TResult = TValueOrError< ResultType, UE::UnifiedError::FError >
 

Enumerations

enum class  UE::UnifiedError::IoStoreOnDemand::ECasErrorCode : uint32 {
  UE::UnifiedError::IoStoreOnDemand::None , UE::UnifiedError::IoStoreOnDemand::InitializeFailed , UE::UnifiedError::IoStoreOnDemand::VerifyFailed , UE::UnifiedError::IoStoreOnDemand::ReadBlockFailed ,
  UE::UnifiedError::IoStoreOnDemand::WriteBlockFailed , UE::UnifiedError::IoStoreOnDemand::DeleteBlockFailed , UE::UnifiedError::IoStoreOnDemand::CreateJournalFailed , UE::UnifiedError::IoStoreOnDemand::ReplayJournalFailed ,
  UE::UnifiedError::IoStoreOnDemand::CommitJournalFailed , UE::UnifiedError::IoStoreOnDemand::CreateSnapshotFailed , UE::UnifiedError::IoStoreOnDemand::LoadSnapshotFailed , UE::UnifiedError::IoStoreOnDemand::SaveSnapshotFailed
}
 

Functions

 UE_DECLARE_ERROR_MODULE (UE_API, IoStoreOnDemand)
 
 UE_DECLARE_ERROR_ONEPARAM (UE_API, HttpError, 1, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "HttpError", "HTTP error ({StatusCode})"), uint32, StatusCode, 0)
 
 UE_DECLARE_ERROR (UE_API, ChunkMissingError, 2, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "ChunkMissingError", "Chunk missing error"))
 
 UE_DECLARE_ERROR (UE_API, ChunkHashError, 3, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "ChunkHashError", "Chunk hash mismatch error"))
 
 UE_DECLARE_ERROR (UE_API, InstallCacheFlushError, 4, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "InstallCacheFlushError", "Failed to flush pending data to install cache."))
 
 UE_DECLARE_ERROR (UE_API, InstallCacheFlushLastAccessError, 5, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "InstallCacheFlushLastAccessError", "Failed to flush last access timestamp(s) to journal."))
 
 UE_DECLARE_ERROR (UE_API, InstallCachePurgeError, 6, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "InstallCachePurgeError", "Failed to purge unreferenced cache block(s) from the install cache."))
 
 UE_DECLARE_ERROR (UE_API, InstallCacheDefragError, 7, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "InstallCacheDefragError", "Failed to defrag the install cache."))
 
 UE_DECLARE_ERROR (UE_API, InstallCacheVerificationError, 8, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "InstallCacheVerificationError", "Verification of installed install cache data failed."))
 
 UE_DECLARE_ERROR (UE_API, CasError, 9, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "CasError", "Cas error"))
 
 UE_DECLARE_ERROR (UE_API, CasJournalError, 10, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "CasJournalError", "Cas journal error"))
 
 UE_DECLARE_ERROR (UE_API, CasSnapshotError, 11, IoStoreOnDemand, NSLOCTEXT("IoStoreOnDemand", "CasSnapshotError", "Cas snapshot error"))
 
const TCHARUE::UnifiedError::IoStoreOnDemand::ToString (ECasErrorCode Code)
 
template<typename ResultType >
UE::IoStore::TResult< ResultType > UE::UnifiedError::IoStoreOnDemand::MakeCasError (ECasErrorCode ErrorCode, EIoErrorCode IoErrorCode, FString &&ErrorMessage, uint32 SystemErrorCode=FPlatformMisc::GetLastError())
 
UE::IoStore::FResult UE::UnifiedError::IoStoreOnDemand::MakeJournalError (ECasErrorCode ErrorCode, EIoErrorCode IoErrorCode, FString &&ErrorMessage, uint32 SystemErrorCode=FPlatformMisc::GetLastError())
 
template<typename ResultType >
UE::IoStore::TResult< ResultType > UE::UnifiedError::IoStoreOnDemand::MakeSnapshotError (ECasErrorCode ErrorCode, EIoErrorCode IoErrorCode, FString &&ErrorMessage, uint32 SystemErrorCode=FPlatformMisc::GetLastError())
 
 UE_DECLARE_ERRORSTRUCT_FEATURES (IoStoreOnDemand, FCasErrorContext)
 
void SerializeForLog (FCbWriter &Writer, const UE::UnifiedError::IoStoreOnDemand::FCasErrorContext &Ctx)
 
 UE_DECLARE_ERRORSTRUCT_FEATURES (IoStoreOnDemand, FChunkMissingErrorContext)
 
void SerializeForLog (FCbWriter &Writer, const UE::UnifiedError::IoStoreOnDemand::FChunkMissingErrorContext &Ctx)
 
 UE_DECLARE_ERRORSTRUCT_FEATURES (IoStoreOnDemand, FChunkHashMismatchErrorContext)
 
void SerializeForLog (FCbWriter &Writer, const UE::UnifiedError::IoStoreOnDemand::FChunkHashMismatchErrorContext &Ctx)
 
 UE_DECLARE_ERRORSTRUCT_FEATURES (IoStoreOnDemand, FInstallCacheErrorContext)
 
void SerializeForLog (FCbWriter &Writer, const UE::UnifiedError::IoStoreOnDemand::FInstallCacheErrorContext &Ctx)
 
 UE_DECLARE_ERRORSTRUCT_FEATURES (IoStoreOnDemand, FVerificationErrorContext)
 
void SerializeForLog (FCbWriter &Writer, const UE::UnifiedError::IoStoreOnDemand::FVerificationErrorContext &Ctx)
 

Macro Definition Documentation

◆ UE_API

Function Documentation

◆ SerializeForLog() [1/5]

void SerializeForLog ( FCbWriter Writer,
const UE::UnifiedError::IoStoreOnDemand::FCasErrorContext Ctx 
)
inline

◆ SerializeForLog() [2/5]

void SerializeForLog ( FCbWriter Writer,
const UE::UnifiedError::IoStoreOnDemand::FChunkHashMismatchErrorContext Ctx 
)
inline

◆ SerializeForLog() [3/5]

void SerializeForLog ( FCbWriter Writer,
const UE::UnifiedError::IoStoreOnDemand::FChunkMissingErrorContext Ctx 
)
inline

◆ SerializeForLog() [4/5]

void SerializeForLog ( FCbWriter Writer,
const UE::UnifiedError::IoStoreOnDemand::FInstallCacheErrorContext Ctx 
)
inline

◆ SerializeForLog() [5/5]

void SerializeForLog ( FCbWriter Writer,
const UE::UnifiedError::IoStoreOnDemand::FVerificationErrorContext Ctx 
)
inline

◆ UE_DECLARE_ERROR() [1/10]

UE_DECLARE_ERROR ( UE_API  ,
CasError  ,
,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "CasError", "Cas error"  
)

◆ UE_DECLARE_ERROR() [2/10]

UE_DECLARE_ERROR ( UE_API  ,
CasJournalError  ,
10  ,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "CasJournalError", "Cas journal error"  
)

◆ UE_DECLARE_ERROR() [3/10]

UE_DECLARE_ERROR ( UE_API  ,
CasSnapshotError  ,
11  ,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "CasSnapshotError", "Cas snapshot error"  
)

◆ UE_DECLARE_ERROR() [4/10]

UE_DECLARE_ERROR ( UE_API  ,
ChunkHashError  ,
,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "ChunkHashError", "Chunk hash mismatch error"  
)

◆ UE_DECLARE_ERROR() [5/10]

UE_DECLARE_ERROR ( UE_API  ,
ChunkMissingError  ,
,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "ChunkMissingError", "Chunk missing error"  
)

◆ UE_DECLARE_ERROR() [6/10]

UE_DECLARE_ERROR ( UE_API  ,
InstallCacheDefragError  ,
,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "InstallCacheDefragError", "Failed to defrag the install cache."  
)

◆ UE_DECLARE_ERROR() [7/10]

UE_DECLARE_ERROR ( UE_API  ,
InstallCacheFlushError  ,
,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "InstallCacheFlushError", "Failed to flush pending data to install cache."  
)

◆ UE_DECLARE_ERROR() [8/10]

UE_DECLARE_ERROR ( UE_API  ,
InstallCacheFlushLastAccessError  ,
,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "InstallCacheFlushLastAccessError", "Failed to flush last access timestamp(s) to journal."  
)

◆ UE_DECLARE_ERROR() [9/10]

UE_DECLARE_ERROR ( UE_API  ,
InstallCachePurgeError  ,
,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "InstallCachePurgeError", "Failed to purge unreferenced cache block(s) from the install cache."  
)

◆ UE_DECLARE_ERROR() [10/10]

UE_DECLARE_ERROR ( UE_API  ,
InstallCacheVerificationError  ,
,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "InstallCacheVerificationError", "Verification of installed install cache data failed."  
)

◆ UE_DECLARE_ERROR_MODULE()

UE_DECLARE_ERROR_MODULE ( UE_API  ,
IoStoreOnDemand   
)

◆ UE_DECLARE_ERROR_ONEPARAM()

UE_DECLARE_ERROR_ONEPARAM ( UE_API  ,
HttpError  ,
,
IoStoreOnDemand  ,
NSLOCTEXT("IoStoreOnDemand", "HttpError", "HTTP error ({StatusCode})")  ,
uint32  ,
StatusCode  ,
 
)

◆ UE_DECLARE_ERRORSTRUCT_FEATURES() [1/5]

UE_DECLARE_ERRORSTRUCT_FEATURES ( IoStoreOnDemand  ,
FCasErrorContext   
)

◆ UE_DECLARE_ERRORSTRUCT_FEATURES() [2/5]

UE_DECLARE_ERRORSTRUCT_FEATURES ( IoStoreOnDemand  ,
FChunkHashMismatchErrorContext   
)

◆ UE_DECLARE_ERRORSTRUCT_FEATURES() [3/5]

UE_DECLARE_ERRORSTRUCT_FEATURES ( IoStoreOnDemand  ,
FChunkMissingErrorContext   
)

◆ UE_DECLARE_ERRORSTRUCT_FEATURES() [4/5]

UE_DECLARE_ERRORSTRUCT_FEATURES ( IoStoreOnDemand  ,
FInstallCacheErrorContext   
)

◆ UE_DECLARE_ERRORSTRUCT_FEATURES() [5/5]

UE_DECLARE_ERRORSTRUCT_FEATURES ( IoStoreOnDemand  ,
FVerificationErrorContext   
)