UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FStructDeserializer Class Reference

#include <StructDeserializer.h>

Static Public Member Functions

static SERIALIZATION_API bool Deserialize (void *OutStruct, UStruct &TypeInfo, IStructDeserializerBackend &Backend, const FStructDeserializerPolicies &Policies)
 
static SERIALIZATION_API bool DeserializeElement (void *OutStruct, UStruct &TypeInfo, int32 ElementIndex, IStructDeserializerBackend &Backend, const FStructDeserializerPolicies &Policies)
 
static bool Deserialize (void *OutStruct, UStruct &TypeInfo, IStructDeserializerBackend &Backend)
 
template<typename StructType >
static bool Deserialize (StructType &OutStruct, IStructDeserializerBackend &Backend)
 
template<typename StructType >
static bool Deserialize (StructType &OutStruct, IStructDeserializerBackend &Backend, const FStructDeserializerPolicies &Policies)
 

Detailed Description

Implements a static class that can deserialize UStruct based types.

This class implements the basic functionality for the serialization of UStructs, such as iterating a structure's properties and writing property values. The actual reading of serialized input data is performed by de-serialization backends, which allows this class to remain serialization format agnostic.

Member Function Documentation

◆ Deserialize() [1/4]

template<typename StructType >
static bool FStructDeserializer::Deserialize ( StructType &  OutStruct,
IStructDeserializerBackend Backend 
)
inlinestatic

Deserializes a data structure from an archive using the default policy.

Parameters
OutStructThe struct to deserialize into.
BackendThe de-serialization backend to use.
Returns
true if deserialization was successful, false otherwise.

◆ Deserialize() [2/4]

template<typename StructType >
static bool FStructDeserializer::Deserialize ( StructType &  OutStruct,
IStructDeserializerBackend Backend,
const FStructDeserializerPolicies Policies 
)
inlinestatic

Deserializes a data structure from an archive using the specified policy.

Parameters
OutStructThe struct to deserialize into.
BackendThe de-serialization backend to use.
PoliciesThe de-serialization policies to use.
Returns
true if deserialization was successful, false otherwise.

◆ Deserialize() [3/4]

static bool FStructDeserializer::Deserialize ( void OutStruct,
UStruct TypeInfo,
IStructDeserializerBackend Backend 
)
inlinestatic

Deserializes a data structure from an archive using the default policy.

Parameters
OutStructA pointer to the data structure to deserialize into.
TypeInfoThe data structure's type information.
BackendThe de-serialization backend to use.
Returns
true if deserialization was successful, false otherwise.

◆ Deserialize() [4/4]

bool FStructDeserializer::Deserialize ( void OutStruct,
UStruct TypeInfo,
IStructDeserializerBackend Backend,
const FStructDeserializerPolicies Policies 
)
static

Deserializes a data structure from an archive using the specified policy.

Parameters
OutStructA pointer to the data structure to deserialize into.
TypeInfoThe data structure's type information.
BackendThe de-serialization backend to use.
PoliciesThe de-serialization policies to use.
Returns
true if deserialization was successful, false otherwise.

◆ DeserializeElement()

bool FStructDeserializer::DeserializeElement ( void OutStruct,
UStruct TypeInfo,
int32  ElementIndex,
IStructDeserializerBackend Backend,
const FStructDeserializerPolicies Policies 
)
static

Deserializes a data structure element from an archive using the specified policy.

Parameters
OutStructA pointer to the data structure to deserialize into.
TypeInfoThe data structure's type information.
ElementIndexThe element index to deserialize in case of a container property.
BackendThe de-serialization backend to use.
PoliciesThe de-serialization policies to use.
Returns
true if deserialization was successful, false otherwise.

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