#include <AsyncLoadingPrivate.h>

Inheritance diagram for FAsyncArchive:

Public Types
enum class	ELoadPhase { WaitingForSize , WaitingForSummary , WaitingForHeader , WaitingForFirstExport , ProcessingExports }

enum class	ELoadError : uint8 { Unknown , UnsupportedFormat , FileDoesNotExist , CorruptData , Cancelled }

Public Member Functions
	FAsyncArchive (const FPackagePath &InPackagePath, FLinkerLoad *InOwner, TFunction< void()> &&InSummaryReadyCallback)

virtual COREUOBJECT_API	~FAsyncArchive ()

virtual COREUOBJECT_API bool	Close () override

virtual COREUOBJECT_API bool	SetCompressionMap (TArray< FCompressedChunk > *CompressedChunks, ECompressionFlags CompressionFlags) override

virtual COREUOBJECT_API bool	Precache (int64 PrecacheOffset, int64 PrecacheSize) override

virtual COREUOBJECT_API void	Serialize (void *Data, int64 Num) override

virtual FORCEINLINE int64	Tell () override

virtual COREUOBJECT_API int64	TotalSize () override

virtual COREUOBJECT_API void	Seek (int64 InPos) override

virtual COREUOBJECT_API void	FlushCache () override

virtual FString	GetArchiveName () const override

COREUOBJECT_API bool	PrecacheWithTimeLimit (int64 PrecacheOffset, int64 PrecacheSize, bool bUseTimeLimit, bool bUseFullTimeLimit, double TickStartTime, double TimeLimit)

COREUOBJECT_API bool	PrecacheForEvent (IAsyncReadRequest *Read, int64 PrecacheOffset, int64 PrecacheSize)

COREUOBJECT_API void	FlushPrecacheBlock ()

COREUOBJECT_API bool	ReadyToStartReadingHeader (bool bUseTimeLimit, bool bUseFullTimeLimit, double TickStartTime, double TimeLimit)

COREUOBJECT_API void	StartReadingHeader ()

COREUOBJECT_API void	EndReadingHeader ()

COREUOBJECT_API IAsyncReadRequest *	MakeEventDrivenPrecacheRequest (int64 Offset, int64 BytesToRead, FAsyncFileCallBack *CompleteCallback)

COREUOBJECT_API void	LogItem (const TCHAR *Item, int64 Offset=0, int64 Size=0, double StartTime=0.0)

bool	IsCookedForEDLInEditor () const

ELoadError	GetLoadError () const

bool	NeedsEngineVersionChecks () const

Public Member Functions inherited from FArchive
	FArchive ()=default

	FArchive (const FArchive &)=default

FArchive &	operator= (const FArchive &ArchiveToCopy)=default

virtual CORE_API	~FArchive ()

virtual FArchive &	operator<< (FName &Value)

virtual CORE_API FArchive &	operator<< (FText &Value)

virtual FArchive &	operator<< (UObject *&Value)

virtual FArchive &	operator<< (FField *&Value)

template<class T >
FArchive &	operator<< (TCheckedObjPtr< T > &Value)

virtual CORE_API FArchive &	operator<< (struct FLazyObjectPtr &Value)

virtual CORE_API FArchive &	operator<< (struct FObjectPtr &Value)

virtual CORE_API FArchive &	operator<< (struct FSoftObjectPtr &Value)

virtual CORE_API FArchive &	operator<< (struct FSoftObjectPath &Value)

virtual CORE_API FArchive &	operator<< (struct FWeakObjectPtr &Value)

virtual void	ForceBlueprintFinalization ()

virtual void	SerializeBits (void *V, int64 LengthBits)

virtual void	SerializeInt (uint32 &Value, uint32 Max)

virtual CORE_API void	SerializeIntPacked (uint32 &Value)

virtual CORE_API void	SerializeIntPacked64 (uint64 &Value)

virtual void	Preload (UObject *Object)

FArchiveState &	GetArchiveState ()

const FArchiveState &	GetArchiveState () const

virtual void	AttachBulkData (UObject Owner, FBulkData BulkData)

virtual void	AttachBulkData (UE::Serialization::FEditorBulkData *BulkData)

virtual void	DetachBulkData (FBulkData *BulkData, bool bEnsureBulkDataIsLoaded)

virtual void	DetachBulkData (UE::Serialization::FEditorBulkData *BulkData, bool bEnsureBulkDataIsLoaded)

virtual bool	SerializeBulkData (FBulkData &BulkData, const FBulkDataSerializationParams &Params)

virtual bool	IsProxyOf (FArchive *InOther) const

virtual void	Flush ()

CORE_API void	SerializeCompressed (void *V, int64 Length, FName CompressionFormatCannotChange, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false)

CORE_API void	SerializeCompressedNew (void V, int64 Length, FName CompressionFormatToEncode, FName CompressionFormatToDecodeOldV1Files, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false, int64 OutPartialReadLength=nullptr)

CORE_API void	SerializeCompressedNew (void *V, int64 Length)

CORE_API void	ByteSwap (void *V, int32 Length)

FArchive &	ByteOrderSerialize (void *V, int32 Length)

void	StartSerializingDefaults ()

void	StopSerializingDefaults ()

virtual void	MarkScriptSerializationStart (const UObject *Obj)

virtual void	MarkScriptSerializationEnd (const UObject *Obj)

virtual void	MarkSearchableName (const TObjectPtr< const UObject > &TypeObject, const FName &ValueName) const

template<typename FmtType , typename... Types>
void	Logf (const FmtType &Fmt, Types... Args)

virtual CORE_API void	UsingCustomVersion (const struct FGuid &Guid)

virtual FArchive *	GetCacheableArchive ()

void	SetCookData (FArchiveCookData *InCookData)

FArchiveCookData *	GetCookData ()

virtual CORE_API void	PushSerializedProperty (class FProperty *InProperty, const bool bIsEditorOnlyProperty)

virtual CORE_API void	PopSerializedProperty (class FProperty *InProperty, const bool bIsEditorOnlyProperty)

virtual bool	AttachExternalReadDependency (FExternalReadCallback &ReadCallback)

template<SIZE_T Size>
bool	FastPathLoad (void *InDest)

virtual void	PushFileRegionType (EFileRegionType Type)

virtual void	PopFileRegionType ()

CORE_API void	SetArchiveState (const FArchiveState &InState)

CORE_API void	SetError ()

CORE_API void	ClearError ()

CORE_API void	SetCriticalError ()

virtual FArchiveState &	GetInnermostState ()

virtual void	CountBytes (SIZE_T InNum, SIZE_T InMax)

virtual FLinker *	GetLinker ()

virtual bool	AtEnd ()

bool	IsByteSwapping ()

void	ThisContainsCode ()

void	ThisContainsMap ()

CORE_API void	ThisRequiresLocalizationGather ()

virtual UObject *	GetArchetypeFromLoader (const UObject *Obj)

UE_FORCEINLINE_HINT FPackageFileVersion	UEVer () const

UE_FORCEINLINE_HINT int32	LicenseeUEVer () const

UE_FORCEINLINE_HINT FEngineVersionBase	EngineVer () const

virtual CORE_API uint32	EngineNetVer () const

virtual CORE_API uint32	GameNetVer () const

CORE_API int32	CustomVer (const struct FGuid &Key) const

UE_FORCEINLINE_HINT bool	IsLoading () const

UE_FORCEINLINE_HINT bool	IsLoadingFromCookedPackage () const

UE_FORCEINLINE_HINT bool	IsSaving () const

bool	IsTransacting () const

UE_FORCEINLINE_HINT bool	IsTextFormat () const

UE_FORCEINLINE_HINT bool	WantBinaryPropertySerialization () const

UE_FORCEINLINE_HINT bool	UseUnversionedPropertySerialization () const

UE_FORCEINLINE_HINT bool	IsForcingUnicode () const

UE_FORCEINLINE_HINT bool	IsPersistent () const

UE_FORCEINLINE_HINT bool	GetError () const

UE_FORCEINLINE_HINT bool	IsError () const

UE_FORCEINLINE_HINT bool	IsCriticalError () const

UE_FORCEINLINE_HINT bool	ContainsCode () const

UE_FORCEINLINE_HINT bool	ContainsMap () const

bool	RequiresLocalizationGather () const

UE_FORCEINLINE_HINT bool	ForceByteSwapping () const

UE_FORCEINLINE_HINT bool	IsSerializingDefaults () const

UE_FORCEINLINE_HINT bool	IsIgnoringArchetypeRef () const

UE_FORCEINLINE_HINT bool	DoDelta () const

UE_FORCEINLINE_HINT bool	DoIntraPropertyDelta () const

UE_FORCEINLINE_HINT bool	IsIgnoringOuterRef () const

UE_FORCEINLINE_HINT bool	IsIgnoringClassGeneratedByRef () const

UE_FORCEINLINE_HINT bool	IsIgnoringClassRef () const

UE_FORCEINLINE_HINT bool	IsAllowingLazyLoading () const

UE_FORCEINLINE_HINT bool	IsObjectReferenceCollector () const

UE_FORCEINLINE_HINT bool	IsModifyingWeakAndStrongReferences () const

UE_FORCEINLINE_HINT bool	IsCountingMemory () const

UE_FORCEINLINE_HINT uint32	GetPortFlags () const

UE_FORCEINLINE_HINT bool	HasAnyPortFlags (uint32 Flags) const

UE_FORCEINLINE_HINT bool	HasAllPortFlags (uint32 Flags) const

uint32	GetDebugSerializationFlags () const

UE_FORCEINLINE_HINT bool	ShouldSkipBulkData () const

UE_FORCEINLINE_HINT int64	GetMaxSerializeSize () const

virtual CORE_API const FCustomVersionContainer &	GetCustomVersions () const

virtual CORE_API void	SetCustomVersions (const FCustomVersionContainer &CustomVersionContainer)

virtual CORE_API void	ResetCustomVersions ()

CORE_API void	SetCustomVersion (const struct FGuid &Key, int32 Version, FName FriendlyName)

void	SetByteSwapping (bool Enabled)

void	SetPortFlags (uint32 InPortFlags)

virtual void	SetDebugSerializationFlags (uint32 InCustomFlags)

bool	IsFilterEditorOnly () const

virtual void	SetFilterEditorOnly (bool InFilterEditorOnly)

bool	IsSavingOptionalObject () const

virtual void	SetSavingOptionalObject (bool InSavingOptionalObject)

bool	IsSaveGame () const

UE_FORCEINLINE_HINT bool	IsNetArchive () const

UE_FORCEINLINE_HINT bool	IsCooking () const

UE_FORCEINLINE_HINT const ITargetPlatform *	CookingTarget () const

void	SetSavePackageData (FArchiveSavePackageData *InSavePackageData)

FArchiveSavePackageData *	GetSavePackageData ()

UE_FORCEINLINE_HINT FArchiveCookContext *	GetCookContext ()

virtual bool	UseToResolveEnumerators () const

virtual bool	ShouldSkipProperty (const FProperty *InProperty) const

virtual void	SetSerializedProperty (FProperty *InProperty)

UE_FORCEINLINE_HINT class FProperty *	GetSerializedProperty () const

CORE_API void	GetSerializedPropertyChain (TArray< class FProperty * > &OutProperties) const

UE_FORCEINLINE_HINT const FArchiveSerializedPropertyChain *	GetSerializedPropertyChain () const

virtual CORE_API void	SetSerializedPropertyChain (const FArchiveSerializedPropertyChain InSerializedPropertyChain, class FProperty InSerializedPropertyOverride=nullptr)

virtual void	SetSerializeContext (FUObjectSerializeContext *InLoadContext)

virtual CORE_API void	Reset ()

virtual CORE_API void	SetIsLoading (bool bInIsLoading)

virtual CORE_API void	SetIsLoadingFromCookedPackage (bool bInIsLoadingFromCookedPackage)

virtual CORE_API void	SetIsSaving (bool bInIsSaving)

virtual CORE_API void	SetIsTransacting (bool bInIsTransacting)

virtual CORE_API void	SetIsTextFormat (bool bInIsTextFormat)

virtual CORE_API void	SetWantBinaryPropertySerialization (bool bInWantBinaryPropertySerialization)

virtual CORE_API void	SetUseUnversionedPropertySerialization (bool bInUseUnversioned)

virtual CORE_API void	SetForceUnicode (bool bInForceUnicode)

virtual CORE_API void	SetIsPersistent (bool bInIsPersistent)

virtual CORE_API void	SetUEVer (FPackageFileVersion InVer)

virtual CORE_API void	SetLicenseeUEVer (int32 InVer)

virtual CORE_API void	SetEngineVer (const FEngineVersionBase &InVer)

virtual CORE_API void	SetEngineNetVer (const uint32 InEngineNetVer)

virtual CORE_API void	SetGameNetVer (const uint32 InGameNetVer)

UE_FORCEINLINE_HINT bool	ShouldSkipCompilingAssets () const

CORE_API void	SetShouldSkipUpdateCustomVersion (bool bShouldSkip)

UE_FORCEINLINE_HINT bool	ShouldSkipUpdateCustomVersion () const

CORE_API void	SetMigratingRemoteObjects (bool bMigrating)

UE_FORCEINLINE_HINT constexpr bool	IsMigratingRemoteObjects () const

virtual const FUObjectMigrationContext *	GetMigrationContext () const

Additional Inherited Members
Public Attributes inherited from FArchive
FFastPathLoadBuffer *	ActiveFPLB

FFastPathLoadBuffer	InlineFPLB

uint8	ArContainsCode: 1

uint8	ArContainsMap: 1

UE_DEPRECATED(5.6, "Public access to ArRequiresLocalizationGather has been deprecated - please use Ar.RequiresLocalizationGather() and Ar.ThisRequiresLocalizationGather() for getting and setting respectively.") uint8 ArRequiresLocalizationGather uint8	ArForceByteSwapping: 1

uint8	ArIgnoreArchetypeRef: 1

uint8	ArNoDelta: 1

uint8	ArNoIntraPropertyDelta: 1

uint8	ArIgnoreOuterRef: 1

uint8	ArIgnoreClassGeneratedByRef: 1

uint8	ArIgnoreClassRef: 1

uint8	ArAllowLazyLoading: 1

uint8	ArIsObjectReferenceCollector: 1

uint8	ArIsModifyingWeakAndStrongReferences: 1

uint8	ArIsCountingMemory: 1

uint8	ArShouldSkipBulkData: 1

uint8	ArIsFilterEditorOnly: 1

uint8	ArIsSavingOptionalObject: 1

uint8	ArIsSaveGame: 1

uint8	ArIsNetArchive: 1

uint8	ArUseCustomPropertyList: 1

int32	ArSerializingDefaults

uint32	ArPortFlags

int64	ArMaxSerializeSize

uint8	ArMergeOverrides: 1

uint8	ArPreserveArrayElements: 1

const struct FCustomPropertyListNode *	ArCustomPropertyList

Protected Member Functions inherited from FArchive
void	SetShouldSkipCompilingAssets (bool Enabled)

Static Protected Member Functions inherited from FArchive
static CORE_API void	LinkProxy (FArchiveState &Inner, FArchiveState &Proxy)

static CORE_API void	UnlinkProxy (FArchiveState &Inner, FArchiveState &Proxy)

Member Enumeration Documentation

◆ ELoadError

enum class FAsyncArchive::ELoadError : uint8

strong

Enumerator
Unknown
UnsupportedFormat
FileDoesNotExist
CorruptData
Cancelled

◆ ELoadPhase

enum class FAsyncArchive::ELoadPhase

strong

Enumerator
WaitingForSize
WaitingForSummary
WaitingForHeader
WaitingForFirstExport
ProcessingExports

Constructor & Destructor Documentation

◆ FAsyncArchive()

FAsyncArchive::FAsyncArchive	(	const FPackagePath &	InPackagePath,
		FLinkerLoad *	InOwner,
		TFunction< void()> &&	InSummaryReadyCallback
	)

◆ ~FAsyncArchive()

FAsyncArchive::~FAsyncArchive ( )

virtual

Member Function Documentation

◆ Close()

bool FAsyncArchive::Close ( )

overridevirtual

Archive overrides

Reimplemented from FArchive.

◆ EndReadingHeader()

void FAsyncArchive::EndReadingHeader ( )

◆ FlushCache()

void FAsyncArchive::FlushCache ( )

overridevirtual

Flushes cache and frees internal data.

Reimplemented from FArchive.

◆ FlushPrecacheBlock()

void FAsyncArchive::FlushPrecacheBlock ( )

◆ GetArchiveName()

virtual FString FAsyncArchive::GetArchiveName ( ) const

inlineoverridevirtual

Returns the name of the Archive. Useful for getting the name of the package a struct or object is in when a loading error occurs.

This is overridden for the specific Archive Types

Reimplemented from FArchive.

◆ GetLoadError()

ELoadError FAsyncArchive::GetLoadError ( ) const

inline

◆ IsCookedForEDLInEditor()

bool FAsyncArchive::IsCookedForEDLInEditor ( ) const

inline

◆ LogItem()

FORCEINLINE void FAsyncArchive::LogItem	(	const TCHAR *	Item,
		int64	Offset = `0`,
		int64	Size = `0`,
		double	StartTime = `0.0`
	)

◆ MakeEventDrivenPrecacheRequest()

IAsyncReadRequest * FAsyncArchive::MakeEventDrivenPrecacheRequest	(	int64	Offset,
		int64	BytesToRead,
		FAsyncFileCallBack *	CompleteCallback
	)

◆ NeedsEngineVersionChecks()

bool FAsyncArchive::NeedsEngineVersionChecks ( ) const

inline

◆ Precache()

bool FAsyncArchive::Precache	(	int64	PrecacheOffset,
		int64	PrecacheSize
	)

overridevirtual

Hint the archive that the region starting at passed in offset and spanning the passed in size is going to be read soon and should be precached.

The function returns whether the precache operation has completed or not which is an important hint for code knowing that it deals with potential async I/O. The archive is free to either not implement this function or only partially precache so it is required that given sufficient time the function will return true. Archives not based on async I/O should always return true.

This function will not change the current archive position.

Parameters

PrecacheOffset	Offset at which to begin precaching.
PrecacheSize	Number of bytes to precache

Returns: false if precache operation is still pending, true otherwise

Reimplemented from FArchive.

◆ PrecacheForEvent()

bool FAsyncArchive::PrecacheForEvent	(	IAsyncReadRequest *	Read,
		int64	PrecacheOffset,
		int64	PrecacheSize
	)

◆ PrecacheWithTimeLimit()

bool FAsyncArchive::PrecacheWithTimeLimit	(	int64	PrecacheOffset,
		int64	PrecacheSize,
		bool	bUseTimeLimit,
		bool	bUseFullTimeLimit,
		double	TickStartTime,
		double	TimeLimit
	)

AsyncArchive interface

◆ ReadyToStartReadingHeader()

bool FAsyncArchive::ReadyToStartReadingHeader	(	bool	bUseTimeLimit,
		bool	bUseFullTimeLimit,
		double	TickStartTime,
		double	TimeLimit
	)

◆ Seek()

void FAsyncArchive::Seek ( int64 InPos )

overridevirtual

Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

Reimplemented from FArchive.

◆ Serialize()

void FAsyncArchive::Serialize	(	void *	Data,
		int64	Num
	)

overridevirtual

Reimplemented from FArchive.

◆ SetCompressionMap()

bool FAsyncArchive::SetCompressionMap	(	TArray< FCompressedChunk > *	CompressedChunks,
		ECompressionFlags	CompressionFlags
	)

overridevirtual

Sets mapping from offsets/ sizes that are going to be used for seeking and serialization to what is actually stored on disk. If the archive supports dealing with compression in this way it is going to return true.

Parameters

CompressedChunks	Pointer to array containing information about [un]compressed chunks
CompressionFlags	Flags determining compression format associated with mapping

Returns: true if archive supports translating offsets & uncompressing on read, false otherwise

Reimplemented from FArchive.

◆ StartReadingHeader()

void FAsyncArchive::StartReadingHeader ( )

◆ Tell()

virtual FORCEINLINE int64 FAsyncArchive::Tell ( )

inlineoverridevirtual

Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

Reimplemented from FArchive.

◆ TotalSize()

int64 FAsyncArchive::TotalSize ( )

overridevirtual

Returns total size of the backing data storage.

Reimplemented from FArchive.

The documentation for this class was generated from the following files:

Engine/Source/Runtime/CoreUObject/Private/Serialization/AsyncLoadingPrivate.h
Engine/Source/Runtime/CoreUObject/Private/Serialization/AsyncLoading.cpp

Public Types

Public Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ ELoadError

◆ ELoadPhase

Constructor & Destructor Documentation

◆ FAsyncArchive()

◆ ~FAsyncArchive()

Member Function Documentation

◆ Close()

◆ EndReadingHeader()

◆ FlushCache()

◆ FlushPrecacheBlock()

◆ GetArchiveName()

◆ GetLoadError()

◆ IsCookedForEDLInEditor()

◆ LogItem()

◆ MakeEventDrivenPrecacheRequest()

◆ NeedsEngineVersionChecks()

◆ Precache()

◆ PrecacheForEvent()

◆ PrecacheWithTimeLimit()

◆ ReadyToStartReadingHeader()

◆ Seek()

◆ Serialize()

◆ SetCompressionMap()

◆ StartReadingHeader()

◆ Tell()

◆ TotalSize()