UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
BuildPatchServices::FChunkDataSerialization Class Reference
+ Inheritance diagram for BuildPatchServices::FChunkDataSerialization:

Public Member Functions

 FChunkDataSerialization (IFileSystem *InFileSystem, EFeatureLevel InFeatureLevel)
 
 ~FChunkDataSerialization ()
 
virtual bool ValidateAndRead (FArchive &InArchive, FMutableMemoryView InDestinationBuffer, FChunkHeader &OutHeader, FUniqueBuffer &OutCompressedBuffer) const override
 
virtual bool DecompressValidatedRead (const FChunkHeader &InHeader, FMutableMemoryView InDestinationBuffer, const FUniqueBuffer &InCompressedBuffer) const override
 
virtual IChunkDataAccessLoadFromFile (const FString &Filename, EChunkLoadResult &OutLoadResult) const override
 
virtual IChunkDataAccessLoadFromMemory (const TArray< uint8 > &Memory, EChunkLoadResult &OutLoadResult) const override
 
virtual IChunkDataAccessLoadFromArchive (FArchive &Archive, EChunkLoadResult &OutLoadResult) const override
 
virtual EChunkSaveResult SaveToFile (const FString &Filename, const IChunkDataAccess *ChunkDataAccess) const override
 
virtual EChunkSaveResult SaveToMemory (TArray< uint8 > &Memory, const IChunkDataAccess *ChunkDataAccess) const override
 
virtual EChunkSaveResult SaveToArchive (FArchive &Archive, const IChunkDataAccess *ChunkDataAccess) const override
 
virtual EChunkSaveResult SaveToArchiveUncompressed (FArchive &Archive, const IChunkDataAccess *ChunkDataAccess) const override
 
virtual void InjectShaToChunkData (TArray< uint8 > &Memory, const FSHAHash &ShaHashData) const override
 
- Public Member Functions inherited from BuildPatchServices::IChunkDataSerialization
virtual ~IChunkDataSerialization ()
 

Static Public Member Functions

static bool CheckChunkHash (const FChunkHeader &Header, const void *Data, uint64 DataLen)
 

Constructor & Destructor Documentation

◆ FChunkDataSerialization()

BuildPatchServices::FChunkDataSerialization::FChunkDataSerialization ( IFileSystem InFileSystem,
EFeatureLevel  InFeatureLevel 
)
inline

◆ ~FChunkDataSerialization()

BuildPatchServices::FChunkDataSerialization::~FChunkDataSerialization ( )
inline

Member Function Documentation

◆ CheckChunkHash()

static bool BuildPatchServices::FChunkDataSerialization::CheckChunkHash ( const FChunkHeader Header,
const void Data,
uint64  DataLen 
)
inlinestatic

◆ DecompressValidatedRead()

virtual bool BuildPatchServices::FChunkDataSerialization::DecompressValidatedRead ( const FChunkHeader InHeader,
FMutableMemoryView  InDestinationBuffer,
const FUniqueBuffer InCompressedBuffer 
) const
inlineoverridevirtual

◆ InjectShaToChunkData()

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

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

Parameters
MemoryThe memory array containing the serialized chunk.
ShaHashDataThe SHA hash to inject.

Implements BuildPatchServices::IChunkDataSerialization.

◆ LoadFromArchive()

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

Loads a chunk from an archive.

Parameters
ArchiveThe archive.
OutLoadResultReceives 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.

Implements BuildPatchServices::IChunkDataSerialization.

◆ LoadFromFile()

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

Loads a chunk from a file on disk or network.

Parameters
FilenameThe full file path to the file.
OutLoadResultReceives 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.

Implements BuildPatchServices::IChunkDataSerialization.

◆ LoadFromMemory()

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

Loads a chunk from memory.

Parameters
MemoryThe memory array.
OutLoadResultReceives 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.

Implements BuildPatchServices::IChunkDataSerialization.

◆ SaveToArchive()

virtual EChunkSaveResult BuildPatchServices::FChunkDataSerialization::SaveToArchive ( FArchive Archive,
const IChunkDataAccess ChunkDataAccess 
) const
inlineoverridevirtual

Saves a chunk to an archive.

Parameters
ArchiveThe archive.
ChunkDataAccessPtr to the chunk data to save.
Returns
the result, EChunkSaveResult::Success if successful.

Implements BuildPatchServices::IChunkDataSerialization.

◆ SaveToArchiveUncompressed()

virtual EChunkSaveResult BuildPatchServices::FChunkDataSerialization::SaveToArchiveUncompressed ( FArchive Archive,
const IChunkDataAccess ChunkDataAccess 
) const
inlineoverridevirtual

◆ SaveToFile()

virtual EChunkSaveResult BuildPatchServices::FChunkDataSerialization::SaveToFile ( const FString &  Filename,
const IChunkDataAccess ChunkDataAccess 
) const
inlineoverridevirtual

Saves a chunk to a file on disk or network.

Parameters
FilenameThe full file path to the file.
ChunkDataAccessPtr to the chunk data to save.
Returns
the result, EChunkSaveResult::Success if successful.

Implements BuildPatchServices::IChunkDataSerialization.

◆ SaveToMemory()

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

Saves a chunk to memory.

Parameters
MemoryThe memory array.
ChunkDataAccessPtr to the chunk data to save.
Returns
the result, EChunkSaveResult::Success if successful.

Implements BuildPatchServices::IChunkDataSerialization.

◆ ValidateAndRead()

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

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