StructSerializer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "Templates/Function.h"
 
class Error;
class FProperty;
class IStructSerializerBackend;
class UStruct;
 
enum class EStructSerializerNullValuePolicies
{
    Ignore,
        
    Serialize
};
 
 
enum class EStructSerializerReferenceLoopPolicies
{
    Error,
        
    Ignore,
        
    Serialize
};
 
enum class EStructSerializerMapPolicies
{
    KeyValuePair,
 
    Array,
};
 
 
struct FStructSerializerPolicies
{
    EStructSerializerNullValuePolicies NullValues;
 
    EStructSerializerReferenceLoopPolicies ReferenceLoops;
 
    EStructSerializerMapPolicies MapSerialization;
 
    TFunction<bool (const FProperty* /*CurrentProp*/, const FProperty* /*ParentProp*/)> PropertyFilter;
 
    FStructSerializerPolicies()
        : NullValues(EStructSerializerNullValuePolicies::Serialize)
        , ReferenceLoops(EStructSerializerReferenceLoopPolicies::Ignore)
        , MapSerialization(EStructSerializerMapPolicies::KeyValuePair)
        , PropertyFilter()
    { }
};
 
 
class FStructSerializer
{
public:
 
    SERIALIZATION_API static void Serialize( const void* Struct, UStruct& TypeInfo, IStructSerializerBackend& Backend, const FStructSerializerPolicies& Policies );
 
    SERIALIZATION_API static void SerializeElement(const void* Address, FProperty* Property, int32 ElementIndex, IStructSerializerBackend& Backend, const FStructSerializerPolicies& Policies);
 
 
    static void Serialize( const void* Struct, UStruct& TypeInfo, IStructSerializerBackend& Backend )
    {
        Serialize(Struct, TypeInfo, Backend, FStructSerializerPolicies());
    }
 
public:
 
    template<typename StructType>
    static void Serialize( const StructType& Struct, IStructSerializerBackend& Backend )
    {
        Serialize(&Struct, *Struct.StaticStruct(), Backend, FStructSerializerPolicies());
    }
 
    template<typename StructType>
    static void Serialize( const StructType& Struct, IStructSerializerBackend& Backend, const FStructSerializerPolicies& Policies )
    {
        Serialize(&Struct, *Struct.StaticStruct(), Backend, Policies);
    }
};