#include <BufferReader.h>

Inheritance diagram for FBufferReaderBase:

Collaboration diagram for FBufferReaderBase:

Public Member Functions
	FBufferReaderBase (void *Data, int64 Size, bool bInFreeOnClose, bool bIsPersistent=false)

virtual	~FBufferReaderBase ()=0

virtual bool	Close () override

void	Serialize (void *Data, int64 Num) final

int64	Tell () final

int64	TotalSize () final

void	Seek (int64 InPos) final

bool	AtEnd () final

virtual FString	GetArchiveName () const

Public Member Functions inherited from FArchive
	FArchive ()=default

	FArchive (const FArchive &)=default

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

	~FArchive ()=default

virtual FArchive &	operator<< (FName &Value)

virtual FArchive &	operator<< (FText &Value)

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

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

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

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

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

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

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

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

virtual void	ForceBlueprintFinalization ()

virtual void	SerializeBits (void *V, int64 LengthBits)

virtual void	SerializeInt (uint32 &Value, uint32 Max)

virtual void	SerializeIntPacked (uint32 &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 struct FBulkDataSerializationParams &Params)

virtual bool	IsProxyOf (FArchive *InOther) const

virtual bool	Precache (int64 PrecacheOffset, int64 PrecacheSize)

virtual void	FlushCache ()

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

virtual void	Flush ()

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

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

void	SerializeCompressedNew (void *V, int64 Length)

void	ByteSwap (void *V, int32 Length)

FORCEINLINE 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 UObject *TypeObject, const FName &ValueName) const

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

virtual void	UsingCustomVersion (const struct FGuid &Guid)

virtual FArchive *	GetCacheableArchive ()

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

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

virtual bool	AttachExternalReadDependency (FExternalReadCallback &ReadCallback)

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

virtual void	PushFileRegionType (EFileRegionType Type)

virtual void	PopFileRegionType ()

void	SetArchiveState (const FArchiveState &InState)

void	SetError ()

void	ClearError ()

virtual FArchiveState &	GetInnermostState ()

virtual void	CountBytes (SIZE_T InNum, SIZE_T InMax)

virtual FLinker *	GetLinker ()

FORCEINLINE bool	IsByteSwapping ()

void	ThisContainsCode ()

void	ThisContainsMap ()

void	ThisRequiresLocalizationGather ()

virtual UObject *	GetArchetypeFromLoader (const UObject *Obj)

FORCEINLINE FPackageFileVersion	UEVer () const

FORCEINLINE int32	UE4Ver () const

FORCEINLINE int32	LicenseeUEVer () const

FORCEINLINE FEngineVersionBase	EngineVer () const

uint32	EngineNetVer () const

uint32	GameNetVer () const

int32	CustomVer (const struct FGuid &Key) const

FORCEINLINE bool	IsLoading () const

FORCEINLINE bool	IsLoadingFromCookedPackage () const

FORCEINLINE bool	IsSaving () const

FORCEINLINE bool	IsTransacting () const

FORCEINLINE bool	IsTextFormat () const

FORCEINLINE bool	WantBinaryPropertySerialization () const

FORCEINLINE bool	UseUnversionedPropertySerialization () const

FORCEINLINE bool	IsForcingUnicode () const

FORCEINLINE bool	IsPersistent () const

FORCEINLINE bool	GetError () const

FORCEINLINE bool	IsError () const

FORCEINLINE bool	IsCriticalError () const

FORCEINLINE bool	ContainsCode () const

FORCEINLINE bool	ContainsMap () const

FORCEINLINE bool	RequiresLocalizationGather () const

FORCEINLINE bool	ForceByteSwapping () const

FORCEINLINE bool	IsSerializingDefaults () const

FORCEINLINE bool	IsIgnoringArchetypeRef () const

FORCEINLINE bool	DoDelta () const

FORCEINLINE bool	DoIntraPropertyDelta () const

FORCEINLINE bool	IsIgnoringOuterRef () const

FORCEINLINE bool	IsIgnoringClassGeneratedByRef () const

FORCEINLINE bool	IsIgnoringClassRef () const

FORCEINLINE bool	IsAllowingLazyLoading () const

FORCEINLINE bool	IsObjectReferenceCollector () const

FORCEINLINE bool	IsModifyingWeakAndStrongReferences () const

FORCEINLINE bool	IsCountingMemory () const

FORCEINLINE uint32	GetPortFlags () const

FORCEINLINE bool	HasAnyPortFlags (uint32 Flags) const

FORCEINLINE bool	HasAllPortFlags (uint32 Flags) const

FORCEINLINE uint32	GetDebugSerializationFlags () const

FORCEINLINE bool	ShouldSkipBulkData () const

FORCEINLINE int64	GetMaxSerializeSize () const

virtual const FCustomVersionContainer &	GetCustomVersions () const

virtual void	SetCustomVersions (const FCustomVersionContainer &CustomVersionContainer)

virtual void	ResetCustomVersions ()

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

void	SetByteSwapping (bool Enabled)

void	SetPortFlags (uint32 InPortFlags)

void	SetDebugSerializationFlags (uint32 InCustomFlags)

bool	IsFilterEditorOnly () const

virtual void	SetFilterEditorOnly (bool InFilterEditorOnly)

bool	IsSaveGame () const

FORCEINLINE bool	IsNetArchive () const

FORCEINLINE bool	IsCooking () const

FORCEINLINE const ITargetPlatform *	CookingTarget () const

void	SetCookData (FArchiveCookData *InCookData)

FArchiveCookData *	GetCookData ()

FORCEINLINE FArchiveCookContext *	GetCookContext ()

virtual bool	UseToResolveEnumerators () const

virtual bool	ShouldSkipProperty (const FProperty *InProperty) const

virtual void	SetSerializedProperty (FProperty *InProperty)

FORCEINLINE struct FProperty *	GetSerializedProperty () const

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

FORCEINLINE const FArchiveSerializedPropertyChain *	GetSerializedPropertyChain () const

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

virtual void	SetSerializeContext (FUObjectSerializeContext *InLoadContext)

virtual FUObjectSerializeContext *	GetSerializeContext ()

virtual void	Reset ()

virtual void	SetIsLoading (bool bInIsLoading)

virtual void	SetIsLoadingFromCookedPackage (bool bInIsLoadingFromCookedPackage)

virtual void	SetIsSaving (bool bInIsSaving)

virtual void	SetIsTransacting (bool bInIsTransacting)

virtual void	SetIsTextFormat (bool bInIsTextFormat)

virtual void	SetWantBinaryPropertySerialization (bool bInWantBinaryPropertySerialization)

virtual void	SetUseUnversionedPropertySerialization (bool bInUseUnversioned)

virtual void	SetForceUnicode (bool bInForceUnicode)

virtual void	SetIsPersistent (bool bInIsPersistent)

virtual void	SetUEVer (FPackageFileVersion InVer)

FORCEINLINE void	SetUE4Ver (int32 InVer)

virtual void	SetLicenseeUEVer (int32 InVer)

virtual void	SetEngineVer (const FEngineVersionBase &InVer)

virtual void	SetEngineNetVer (const uint32 InEngineNetVer)

virtual void	SetGameNetVer (const uint32 InGameNetVer)

FORCEINLINE bool	ShouldSkipCompilingAssets () const

Protected Attributes
void *	ReaderData

int64	ReaderPos

int64	ReaderSize

bool	bFreeOnClose

Additional Inherited Members
Public Attributes inherited from FArchive
FFastPathLoadBuffer *	ActiveFPLB

FFastPathLoadBuffer	InlineFPLB

uint8	ArContainsCode: 1

uint8	ArContainsMap: 1

uint8	ArRequiresLocalizationGather: 1

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	ArIsSaveGame: 1

uint8	ArIsNetArchive: 1

uint8	ArUseCustomPropertyList: 1

int32	ArSerializingDefaults

uint32	ArPortFlags

int64	ArMaxSerializeSize

const struct FCustomPropertyListNode *	ArCustomPropertyList

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

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

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

Detailed Description

Similar to FMemoryReader, but able to internally manage the memory for the buffer.

Definition at line 15 of file BufferReader.h.

Constructor & Destructor Documentation

◆ FBufferReaderBase()

FBufferReaderBase::FBufferReaderBase	(	void *	Data,
		int64	Size,
		bool	bInFreeOnClose,
		bool	bIsPersistent = false )

inline

Constructor

Parameters

Data	Buffer to use as the source data to read from
Size	Size of Data
bInFreeOnClose	If true, Data will be FMemory::Free'd when this archive is closed
bIsPersistent	Uses this value for SetIsPersistent()
bInSHAVerifyOnClose	It true, an async SHA verification will be done on the Data buffer (bInFreeOnClose will be passed on to the async task)

Definition at line 27 of file BufferReader.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~FBufferReaderBase()

FBufferReaderBase::~FBufferReaderBase ( )

inlinepure virtual

Definition at line 88 of file BufferReader.h.

Member Function Documentation

◆ AtEnd()

bool FBufferReaderBase::AtEnd ( )

inlinefinalvirtual

Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage.

Reimplemented from FArchive.

Definition at line 70 of file BufferReader.h.

◆ Close()

virtual bool FBufferReaderBase::Close ( )

inlineoverridevirtual

Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded.

Reimplemented from FArchive.

Reimplemented in FBufferReaderWithSHA.

Definition at line 40 of file BufferReader.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetArchiveName()

virtual FString FBufferReaderBase::GetArchiveName ( ) const

inlinevirtual

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.

Reimplemented in FBufferReaderWithSHA, and FBufferReader.

Definition at line 80 of file BufferReader.h.

◆ Seek()

void FBufferReaderBase::Seek ( int64 InPos )

inlinefinalvirtual

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

Reimplemented from FArchive.

Definition at line 64 of file BufferReader.h.

◆ Serialize()

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

inlinefinalvirtual

Reimplemented from FArchive.

Definition at line 49 of file BufferReader.h.

Here is the call graph for this function:

◆ Tell()

int64 FBufferReaderBase::Tell ( )

inlinefinalvirtual

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.

Definition at line 56 of file BufferReader.h.

◆ TotalSize()

int64 FBufferReaderBase::TotalSize ( )

inlinefinalvirtual

Returns total size of the backing data storage.

Reimplemented from FArchive.

Definition at line 60 of file BufferReader.h.

Member Data Documentation

◆ bFreeOnClose

bool FBufferReaderBase::bFreeOnClose

protected

Definition at line 85 of file BufferReader.h.

◆ ReaderData

void* FBufferReaderBase::ReaderData

protected

Definition at line 82 of file BufferReader.h.

◆ ReaderPos

int64 FBufferReaderBase::ReaderPos

protected

Definition at line 83 of file BufferReader.h.

◆ ReaderSize

int64 FBufferReaderBase::ReaderSize

protected

Definition at line 84 of file BufferReader.h.

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

C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Serialization/BufferReader.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBufferReaderBase()

◆ ~FBufferReaderBase()

Member Function Documentation

◆ AtEnd()

◆ Close()

◆ GetArchiveName()

◆ Seek()

◆ Serialize()

◆ Tell()

◆ TotalSize()

Member Data Documentation

◆ bFreeOnClose

◆ ReaderData

◆ ReaderPos

◆ ReaderSize