CompactBinarySerialization.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ContainersFwd.h"
#include "Containers/StringFwd.h"
#include "CoreTypes.h"
#include "IO/IoHash.h"
#include "Memory/MemoryFwd.h"
#include "Memory/MemoryView.h"
#include "Memory/SharedBuffer.h"
#include "Serialization/CompactBinary.h"
#include "Templates/Function.h"
 
class FArchive;
class FName;
struct FDateTime;
struct FGuid;
 
 
namespace UE::Serialization::Private
{
 
CORE_API void LogFieldTooLargeForArrayWarning(uint64 FieldLength);
 
} // namespace UE::Serialization::Private
 
 
CORE_API uint64 MeasureCompactBinary(FMemoryView View, ECbFieldType Type = ECbFieldType::HasFieldType);
 
CORE_API bool TryMeasureCompactBinary(
    FMemoryView InView,
    ECbFieldType& OutType,
    uint64& OutSize,
    ECbFieldType InType = ECbFieldType::HasFieldType);
 
 
CORE_API FCbField LoadCompactBinary(FArchive& Ar, FCbBufferAllocator Allocator = FUniqueBuffer::Alloc);
 
CORE_API void SaveCompactBinary(FArchive& Ar, const FCbFieldView& Field);
CORE_API void SaveCompactBinary(FArchive& Ar, const FCbArrayView& Array);
CORE_API void SaveCompactBinary(FArchive& Ar, const FCbObjectView& Object);
 
CORE_API FArchive& operator<<(FArchive& Ar, FCbField& Field);
CORE_API FArchive& operator<<(FArchive& Ar, FCbArray& Array);
CORE_API FArchive& operator<<(FArchive& Ar, FCbObject& Object);
 
 
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, FUtf8StringBuilderBase& OutValue);
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, FWideStringBuilderBase& OutValue);
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, UE::FUtf8SharedString& OutString);
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, UE::FWideSharedString& OutString);
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, FUtf8String& OutValue);
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, FWideString& OutValue);
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, FName& OutValue);
 
inline bool LoadFromCompactBinary(FCbFieldView Field, int8& OutValue, const int8 Default = 0)
{
    OutValue = Field.AsInt8(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, int16& OutValue, const int16 Default = 0)
{
    OutValue = Field.AsInt16(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, int32& OutValue, const int32 Default = 0)
{
    OutValue = Field.AsInt32(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, int64& OutValue, const int64 Default = 0)
{
    OutValue = Field.AsInt64(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, uint8& OutValue, const uint8 Default = 0)
{
    OutValue = Field.AsUInt8(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, uint16& OutValue, const uint16 Default = 0)
{
    OutValue = Field.AsUInt16(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, uint32& OutValue, const uint32 Default = 0)
{
    OutValue = Field.AsUInt32(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, uint64& OutValue, const uint64 Default = 0)
{
    OutValue = Field.AsUInt64(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, float& OutValue, const float Default = 0.0f)
{
    OutValue = Field.AsFloat(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, double& OutValue, const double Default = 0.0)
{
    OutValue = Field.AsDouble(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, bool& OutValue, const bool Default = false)
{
    OutValue = Field.AsBool(Default);
    return !Field.HasError();
}
 
inline bool LoadFromCompactBinary(FCbFieldView Field, FIoHash& OutValue, const FIoHash& Default = FIoHash())
{
    OutValue = Field.AsHash(Default);
    return !Field.HasError();
}
 
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, FGuid& OutValue);
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, FGuid& OutValue, const FGuid& Default);
 
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, FDateTime& OutValue);
CORE_API bool LoadFromCompactBinary(FCbFieldView Field, FDateTime& OutValue, FDateTime Default);
 
inline bool LoadFromCompactBinary(FCbFieldView Field, FCbObjectId& OutValue, const FCbObjectId& Default = FCbObjectId())
{
    OutValue = Field.AsObjectId(Default);
    return !Field.HasError();
}
 
template <typename T, typename Allocator>
inline bool LoadFromCompactBinary(FCbFieldView Field, TArray<T, Allocator>& OutValue)
{
    const uint64 Length = Field.AsArrayView().Num();
    if (Length <= MAX_int32)
    {
        OutValue.Reset((int32)Length);
        bool bOk = !Field.HasError();
        for (const FCbFieldView& ElementField : Field)
        {
            bOk = LoadFromCompactBinary(ElementField, OutValue.Emplace_GetRef()) & bOk;
        }
        return bOk;
    }
    else
    {
        UE::Serialization::Private::LogFieldTooLargeForArrayWarning(Length);
        return false;
    }
}
 
 
CORE_API void CompactBinaryToJson(const FCbFieldView& Field, FUtf8StringBuilderBase& Builder);
CORE_API void CompactBinaryToJson(const FCbFieldView& Field, FWideStringBuilderBase& Builder);
CORE_API void CompactBinaryToJson(const FCbArrayView& Array, FUtf8StringBuilderBase& Builder);
CORE_API void CompactBinaryToJson(const FCbArrayView& Array, FWideStringBuilderBase& Builder);
CORE_API void CompactBinaryToJson(const FCbObjectView& Object, FUtf8StringBuilderBase& Builder);
CORE_API void CompactBinaryToJson(const FCbObjectView& Object, FWideStringBuilderBase& Builder);
 
CORE_API void CompactBinaryToCompactJson(const FCbFieldView& Field, FUtf8StringBuilderBase& Builder);
CORE_API void CompactBinaryToCompactJson(const FCbFieldView& Field, FWideStringBuilderBase& Builder);
CORE_API void CompactBinaryToCompactJson(const FCbArrayView& Array, FUtf8StringBuilderBase& Builder);
CORE_API void CompactBinaryToCompactJson(const FCbArrayView& Array, FWideStringBuilderBase& Builder);
CORE_API void CompactBinaryToCompactJson(const FCbObjectView& Object, FUtf8StringBuilderBase& Builder);
CORE_API void CompactBinaryToCompactJson(const FCbObjectView& Object, FWideStringBuilderBase& Builder);