BuildPatchServices::IChunkDataSerialization Class Reference

#include <ChunkData.h>

Inheritance diagram for BuildPatchServices::IChunkDataSerialization:

Public Member Functions
virtual	~IChunkDataSerialization ()
virtual IChunkDataAccess *	LoadFromFile (const FString &Filename, EChunkLoadResult &OutLoadResult) const =0
virtual IChunkDataAccess *	LoadFromMemory (const TArray< uint8 > &Memory, EChunkLoadResult &OutLoadResult) const =0
virtual IChunkDataAccess *	LoadFromArchive (FArchive &Archive, EChunkLoadResult &OutLoadResult) const =0
virtual EChunkSaveResult	SaveToFile (const FString &Filename, const IChunkDataAccess *ChunkDataAccess) const =0
virtual EChunkSaveResult	SaveToMemory (TArray< uint8 > &Memory, const IChunkDataAccess *ChunkDataAccess) const =0
virtual EChunkSaveResult	SaveToArchive (FArchive &Archive, const IChunkDataAccess *ChunkDataAccess) const =0
virtual EChunkSaveResult	SaveToArchiveUncompressed (FArchive &Archive, const IChunkDataAccess *ChunkDataAccess) const
virtual bool	ValidateAndRead (FArchive &InArchive, FMutableMemoryView InDestinationBuffer, FChunkHeader &OutHeader, FUniqueBuffer &OutCompressedBuffer) const =0
virtual bool	DecompressValidatedRead (const FChunkHeader &InHeader, FMutableMemoryView InDestionationBuffer, const FUniqueBuffer &InCompressedBuffer) const =0
virtual void	InjectShaToChunkData (TArray< uint8 > &Memory, const FSHAHash &ShaHashData) const =0

Detailed Description

An interface providing serialization for chunk data.

Constructor & Destructor Documentation

~IChunkDataSerialization()

virtual BuildPatchServices::IChunkDataSerialization::~IChunkDataSerialization ( )

inlinevirtual

Member Function Documentation

DecompressValidatedRead()

virtual bool BuildPatchServices::IChunkDataSerialization::DecompressValidatedRead ( const FChunkHeader &  InHeader, FMutableMemoryView  InDestionationBuffer, const FUniqueBuffer &  InCompressedBuffer  ) const

pure virtual

Implemented in BuildPatchServices::FChunkDataSerialization.

InjectShaToChunkData()

virtual void BuildPatchServices::IChunkDataSerialization::InjectShaToChunkData ( TArray< uint8 > &  Memory, const FSHAHash &  ShaHashData  ) const

pure virtual

Injects an SHA hash for the data into the structure of a serialized chunk.

Parameters

Memory	The memory array containing the serialized chunk.
ShaHashData	The SHA hash to inject.

Implemented in BuildPatchServices::FChunkDataSerialization.

LoadFromArchive()

virtual IChunkDataAccess * BuildPatchServices::IChunkDataSerialization::LoadFromArchive ( FArchive &  Archive, EChunkLoadResult &  OutLoadResult  ) const

pure virtual

Loads a chunk from an archive.

Parameters

Archive	The archive.
OutLoadResult	Receives the result, indicating the error reason if return value is nullptr.

Returns

ptr to an allocated IChunkDataAccess holding the data, nullptr if failed to load.

Implemented in BuildPatchServices::FChunkDataSerialization.

LoadFromFile()

virtual IChunkDataAccess * BuildPatchServices::IChunkDataSerialization::LoadFromFile ( const FString &  Filename, EChunkLoadResult &  OutLoadResult  ) const

pure virtual

Loads a chunk from a file on disk or network.

Parameters

Filename	The full file path to the file.
OutLoadResult	Receives the result, indicating the error reason if return value is nullptr.

Returns

ptr to an allocated IChunkDataAccess holding the data, nullptr if failed to load.

Implemented in BuildPatchServices::FChunkDataSerialization.

LoadFromMemory()

virtual IChunkDataAccess * BuildPatchServices::IChunkDataSerialization::LoadFromMemory ( const TArray< uint8 > &  Memory, EChunkLoadResult &  OutLoadResult  ) const

pure virtual

Loads a chunk from memory.

Parameters

Memory	The memory array.
OutLoadResult	Receives the result, indicating the error reason if return value is nullptr.

Returns

ptr to an allocated IChunkDataAccess holding the data, nullptr if failed to load.

Implemented in BuildPatchServices::FChunkDataSerialization.

SaveToArchive()

virtual EChunkSaveResult BuildPatchServices::IChunkDataSerialization::SaveToArchive ( FArchive &  Archive, const IChunkDataAccess *  ChunkDataAccess  ) const

pure virtual

Saves a chunk to an archive.

Parameters

Archive	The archive.
ChunkDataAccess	Ptr to the chunk data to save.

Returns

the result, EChunkSaveResult::Success if successful.

Implemented in BuildPatchServices::FChunkDataSerialization.

SaveToArchiveUncompressed()

virtual EChunkSaveResult BuildPatchServices::IChunkDataSerialization::SaveToArchiveUncompressed ( FArchive &  Archive, const IChunkDataAccess *  ChunkDataAccess  ) const

inlinevirtual

Reimplemented in BuildPatchServices::FChunkDataSerialization.

SaveToFile()

virtual EChunkSaveResult BuildPatchServices::IChunkDataSerialization::SaveToFile ( const FString &  Filename, const IChunkDataAccess *  ChunkDataAccess  ) const

pure virtual

Saves a chunk to a file on disk or network.

Parameters

Filename	The full file path to the file.
ChunkDataAccess	Ptr to the chunk data to save.

Returns

the result, EChunkSaveResult::Success if successful.

Implemented in BuildPatchServices::FChunkDataSerialization.

SaveToMemory()

virtual EChunkSaveResult BuildPatchServices::IChunkDataSerialization::SaveToMemory ( TArray< uint8 > &  Memory, const IChunkDataAccess *  ChunkDataAccess  ) const

pure virtual

Saves a chunk to memory.

Parameters

Memory	The memory array.
ChunkDataAccess	Ptr to the chunk data to save.

Returns

the result, EChunkSaveResult::Success if successful.

Implemented in BuildPatchServices::FChunkDataSerialization.

ValidateAndRead()

virtual bool BuildPatchServices::IChunkDataSerialization::ValidateAndRead ( FArchive &  InArchive, FMutableMemoryView  InDestinationBuffer, FChunkHeader &  OutHeader, FUniqueBuffer &  OutCompressedBuffer  ) const

pure virtual

Implemented in BuildPatchServices::FChunkDataSerialization.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Data/ChunkData.h