FStructSerializer

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

Windows
MacOS
Linux

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

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& P...
)

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& P...
)

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss