#include <FileManagerGeneric.h>

Inheritance diagram for FArchiveFileWriterGeneric:

Collaboration diagram for FArchiveFileWriterGeneric:

Public Member Functions
	FArchiveFileWriterGeneric (IFileHandle InHandle, const TCHAR InFilename, int64 InPos, uint32 InBufferSize=PLATFORM_FILE_WRITER_BUFFER_SIZE, uint32 InFlags=FILEWRITE_None)

	~FArchiveFileWriterGeneric ()

virtual void	Seek (int64 InPos) override final

virtual int64	Tell () override final

virtual int64	TotalSize () override

virtual bool	Close () override final

virtual void	Serialize (void *V, int64 Length) override final

virtual void	Flush () override final

virtual FString	GetArchiveName () const override

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)

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 ()

virtual bool	AtEnd ()

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 Member Functions
bool	FlushBuffer ()

virtual bool	SeekLowLevel (int64 InPos)

virtual bool	CloseLowLevel ()

virtual bool	WriteLowLevel (const uint8 *Src, int64 CountToWrite)

void	LogWriteError (const TCHAR *Message)

bool	IsSilent () const

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

Protected Attributes
FString	Filename

uint32	Flags

int64	Pos

TUniquePtr< IFileHandle >	Handle

TArray64< uint8 >	BufferArray

int64	BufferSize

bool	bLoggingError

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

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

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

Detailed Description

Definition at line 303 of file FileManagerGeneric.h.

Constructor & Destructor Documentation

◆ FArchiveFileWriterGeneric()

FArchiveFileWriterGeneric::FArchiveFileWriterGeneric	(	IFileHandle *	InHandle,
		const TCHAR *	InFilename,
		int64	InPos,
		uint32	InBufferSize = PLATFORM_FILE_WRITER_BUFFER_SIZE,
		uint32	InFlags = FILEWRITE_None )

◆ ~FArchiveFileWriterGeneric()

FArchiveFileWriterGeneric::~FArchiveFileWriterGeneric ( )

Member Function Documentation

◆ Close()

virtual bool FArchiveFileWriterGeneric::Close ( )

finaloverridevirtual

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

Reimplemented from FArchive.

◆ CloseLowLevel()

virtual bool FArchiveFileWriterGeneric::CloseLowLevel ( )

protectedvirtual

Close the file handle

Returns: false on failure

◆ Flush()

virtual void FArchiveFileWriterGeneric::Flush ( )

finaloverridevirtual

Attempts to finish writing any buffered data to disk/permanent storage.

Reimplemented from FArchive.

◆ FlushBuffer()

bool FArchiveFileWriterGeneric::FlushBuffer ( )

protected

Write any internal buffer to the file handle

Note: Doesn't flush the handle itself, so this data may be cached by the OS and not yet written to disk!

Returns: true if there was buffer data and it was written successfully, false if there was nothing to flush or the write failed

◆ GetArchiveName()

virtual FString FArchiveFileWriterGeneric::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.

Definition at line 318 of file FileManagerGeneric.h.

◆ IsSilent()

bool FArchiveFileWriterGeneric::IsSilent ( ) const

inlineprotected

Returns true if the archive should suppress logging in case of error

Definition at line 359 of file FileManagerGeneric.h.

◆ LogWriteError()

void FArchiveFileWriterGeneric::LogWriteError ( const TCHAR * Message )

protected

Logs I/O error It is important to not call any platform API functions after the error occurred and before calling this functions as the system error code may get reset and will not be properly logged in this message.

Parameters

Message Brief description of what went wrong

◆ Seek()

virtual void FArchiveFileWriterGeneric::Seek ( int64 InPos )

finaloverridevirtual

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

Reimplemented from FArchive.

◆ SeekLowLevel()

virtual bool FArchiveFileWriterGeneric::SeekLowLevel ( int64 InPos )

protectedvirtual

Platform specific seek

Parameters

InPos - Offset from beginning of file to seek to

Returns: false on failure

◆ Serialize()

virtual void FArchiveFileWriterGeneric::Serialize	(	void *	V,
		int64	Length )

finaloverridevirtual

Reimplemented from FArchive.

◆ Tell()

virtual int64 FArchiveFileWriterGeneric::Tell ( )

inlinefinaloverridevirtual

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 310 of file FileManagerGeneric.h.

◆ TotalSize()

virtual int64 FArchiveFileWriterGeneric::TotalSize ( )

overridevirtual

Returns total size of the backing data storage.

Reimplemented from FArchive.

◆ WriteLowLevel()

virtual bool FArchiveFileWriterGeneric::WriteLowLevel	(	const uint8 *	Src,
		int64	CountToWrite )

protectedvirtual

Platform specific write

Parameters

Src	- Buffer to write out
CountToWrite	- Number of bytes to write

Returns: false on failure

Member Data Documentation

◆ bLoggingError

bool FArchiveFileWriterGeneric::bLoggingError

protected

Definition at line 371 of file FileManagerGeneric.h.

◆ BufferArray

TArray64<uint8> FArchiveFileWriterGeneric::BufferArray

protected

Definition at line 369 of file FileManagerGeneric.h.

◆ BufferSize

int64 FArchiveFileWriterGeneric::BufferSize

protected

Definition at line 370 of file FileManagerGeneric.h.

◆ Filename

FString FArchiveFileWriterGeneric::Filename

protected

Filename for debugging purposes

Definition at line 365 of file FileManagerGeneric.h.

◆ Flags

uint32 FArchiveFileWriterGeneric::Flags

protected

Definition at line 366 of file FileManagerGeneric.h.

◆ Handle

TUniquePtr<IFileHandle> FArchiveFileWriterGeneric::Handle

protected

Definition at line 368 of file FileManagerGeneric.h.

◆ Pos

int64 FArchiveFileWriterGeneric::Pos

protected

Definition at line 367 of file FileManagerGeneric.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/HAL/FileManagerGeneric.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FArchiveFileWriterGeneric()

◆ ~FArchiveFileWriterGeneric()

Member Function Documentation

◆ Close()

◆ CloseLowLevel()

◆ Flush()

◆ FlushBuffer()

◆ GetArchiveName()

◆ IsSilent()

◆ LogWriteError()

◆ Seek()

◆ SeekLowLevel()

◆ Serialize()

◆ Tell()

◆ TotalSize()

◆ WriteLowLevel()

Member Data Documentation

◆ bLoggingError

◆ BufferArray

◆ BufferSize

◆ Filename

◆ Flags

◆ Handle

◆ Pos