1. Epic GamesDeveloper
  3. FStructSerializer

FStructSerializer

Implements a static class that can serialize [UStruct](API\Runtime\CoreUObject\UObject\UStruct) based types.

API > API/Runtime > API/Runtime/Serialization

References

   
Module Serialization
Header /Engine/Source/Runtime/Serialization/Public/StructSerializer.h
Include #include "StructSerializer.h"

Syntax

class FStructSerializer

Remarks

Implements a static class that can serialize 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 writing of serialized output data is performed by serialization backends, which allows this class to remain serialization format agnostic.

The serializer's behavior can be customized with serialization policies. This allows for control over how to handle null values, circular references and other edge cases.

Functions

  Type Name Description
Public function Static void

Serialize ( const StructType& Struct,
IStructSerializerBackend& Backend
)

 Serializes a given USTRUCT to a string using the default policy.
Public function Static void

Serialize ( const void* Struct,
UStruct& TypeInfo,
IStructSerializerBackend& Backend
)

 Serializes a given data structure of the specified type using the default policy.
Public function Static void

Serialize ( const StructType& Struct,
IStructSerializerBackend& Backend,
const FStructSerializerPolicies& Policies
)

 Serializes a given USTRUCT to a string using the specified policy.
Public function Static void

Serialize ( const void* Struct,
UStruct& TypeInfo,
IStructSerializerBackend& Backend,
const FStructSerializerPolicies& Policies
)

 Serializes a given data structure of the specified type using the specified policy.
Public function Static void

SerializeElement ( const void* Address,
FProperty* Property,
int32 ElementIndex,
IStructSerializerBackend& Backend,
const FStructSerializerPolicies& Policies
)

 Serializes a given element of a data structure of the specified type using the specified policy.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page