StructDeserializer.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 IStructDeserializerBackend;
class UStruct;
 
enum class EStructDeserializerErrorPolicies
{
    Error,
        
    Ignore,
        
    Warning,
};
 
enum class EStructDeserializerMapPolicies
{
    KeyValuePair,
 
    Array,
};
 
 
struct FStructDeserializerPolicies
{
    EStructDeserializerErrorPolicies MissingFields;
 
    EStructDeserializerMapPolicies MapPolicies;
 
    TFunction<bool (const FProperty* /*CurrentProp*/, const FProperty* /*ParentProp*/)> PropertyFilter;
 
    FStructDeserializerPolicies()
        : MissingFields(EStructDeserializerErrorPolicies::Ignore)
        , MapPolicies(EStructDeserializerMapPolicies::KeyValuePair)
        , PropertyFilter()
    { }
};
 
 
class FStructDeserializer
{
public:
 
    SERIALIZATION_API static bool Deserialize( void* OutStruct, UStruct& TypeInfo, IStructDeserializerBackend& Backend, const FStructDeserializerPolicies& Policies );
    
    SERIALIZATION_API static bool DeserializeElement(void* OutStruct, UStruct& TypeInfo, int32 ElementIndex, IStructDeserializerBackend& Backend, const FStructDeserializerPolicies& Policies);
 
    static bool Deserialize( void* OutStruct, UStruct& TypeInfo, IStructDeserializerBackend& Backend )
    {
        return Deserialize(OutStruct, TypeInfo, Backend, FStructDeserializerPolicies());
    }
 
public:
 
    template<typename StructType>
    static bool Deserialize( StructType& OutStruct, IStructDeserializerBackend& Backend )
    {
        return Deserialize(&OutStruct, *StructType::StaticStruct(), Backend);
    }
 
    template<typename StructType>
    static bool Deserialize( StructType& OutStruct, IStructDeserializerBackend& Backend, const FStructDeserializerPolicies& Policies )
    {
        return Deserialize(&OutStruct, *StructType::StaticStruct(), Backend, Policies);
    }
};