CompactBinaryValidation.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Memory/MemoryFwd.h"
#include "Memory/MemoryView.h"
#include "Misc/EnumClassFlags.h"
#include "Serialization/CompactBinary.h"
 
class FCbAttachment;
class FCbPackage;
 
 
enum class ECbValidateMode : uint32
{
    None                    = 0,
 
    Default                 = 1 << 0,
 
    Names                   = 1 << 1,
 
    Format                  = 1 << 2,
 
    Padding                 = 1 << 3,
 
    Package                 = 1 << 4,
 
    PackageHash             = 1 << 5,
 
    All                     = Default | Names | Format | Padding | Package | PackageHash,
};
 
ENUM_CLASS_FLAGS(ECbValidateMode);
 
 
enum class ECbValidateError : uint32
{
    None                    = 0,
 
    // Mode: Default
 
    OutOfBounds             = 1 << 0,
    InvalidType             = 1 << 1,
 
    // Mode: Names
 
    DuplicateName           = 1 << 2,
    MissingName             = 1 << 3,
    ArrayName               = 1 << 4,
 
    // Mode: Format
 
    InvalidString           = 1 << 5,
    InvalidInteger          = 1 << 6,
    InvalidFloat            = 1 << 7,
    NonUniformObject        = 1 << 8,
    NonUniformArray         = 1 << 9,
 
    // Mode: Padding
 
    Padding                 = 1 << 10,
 
    // Mode: Package
 
    InvalidPackageFormat    = 1 << 11,
    InvalidPackageHash      = 1 << 12,
    DuplicateAttachments    = 1 << 13,
    MultiplePackageObjects  = 1 << 14,
    NullPackageObject       = 1 << 15,
    NullPackageAttachment   = 1 << 16,
};
 
ENUM_CLASS_FLAGS(ECbValidateError);
 
 
CORE_API ECbValidateError ValidateCompactBinary(FMemoryView View, ECbValidateMode Mode, ECbFieldType Type = ECbFieldType::HasFieldType);
 
CORE_API ECbValidateError ValidateCompactBinaryRange(FMemoryView View, ECbValidateMode Mode);
 
CORE_API ECbValidateError ValidateCompactBinaryAttachment(FMemoryView View, ECbValidateMode Mode);
 
CORE_API ECbValidateError ValidateCompactBinaryPackage(FMemoryView View, ECbValidateMode Mode);
 
CORE_API ECbValidateError ValidateCompactBinary(const FCbField& Value, ECbValidateMode Mode);
CORE_API ECbValidateError ValidateCompactBinary(const FCbArray& Value, ECbValidateMode Mode);
CORE_API ECbValidateError ValidateCompactBinary(const FCbObject& Value, ECbValidateMode Mode);
CORE_API ECbValidateError ValidateCompactBinary(const FCbPackage& Value, ECbValidateMode Mode);
CORE_API ECbValidateError ValidateCompactBinary(const FCbAttachment& Value, ECbValidateMode Mode);