Serialization

Choose your operating system:

Windows

macOS

Linux

Filters

Classes

Name

Description

Public struct

CProvidesDefaultUObject

Access to a global default object is required in order to patch vtables Normally this can be provided by a default-constructed object.

Public struct

CProvidesStaticClass

Public struct

CProvidesStaticStruct

Public struct

CTypeLayout

Public struct

ECustomVersionSerializationFormat

Public class

FArchive

Base class for archives that can be used for loading, saving, and garbage collecting in a byte order neutral way.

Public struct

FArchiveFieldName

Define a structure to encapsulate a field name, which compiles to an empty object if WITH_TEXT_ARCHIVE_SUPPORT = 0.

Public class

FArchiveFromStructuredArchive

Public class

FArchiveFromStructuredArchiveImpl

Public class

FArchiveLoadCompressedProxy

FArchive Proxy to transparently load compressed data from an array.

Public class

FArchiveProxy

Base class for archive proxies.

Public class

FArchiveSaveCompressedProxy

FArchive Proxy to transparently write out compressed data to an array.

Public struct

FArchiveSerializedPropertyChain

Structure containing the stack of properties that are currently being serialized by an archive

Public struct

FArchiveState

Public class

FArrayReader

Public class

FBitArchive

Base class for serializing bitstreams.

Public struct

FBitReader

Reads bitstreams.

Public struct

FBitReaderMark

For pushing and popping FBitWriter positions.

Public struct

FBitWriter

Writes bitstreams.

Public struct

FBitWriterMark

For pushing and popping FBitWriter positions.

Public class

FBufferArchive

Buffer archiver.

Public class

FBufferReader

Similar to FMemoryReader, but able to internally manage the memory for the buffer.

Public class

FBufferReaderBase

Similar to FMemoryReader, but able to internally manage the memory for the buffer.

Public class

FBufferWriter

Similar to FMemoryWriter, but able to internally manage the memory for the buffer.

Public class

FCbArray

An array that includes a shared buffer for the memory that contains it.

Public class

FCbArrayView

Array of FCbField[View] that have no names.

Public class

FCbAttachment

An attachment is either null, raw binary, compressed binary, or an object.

Public struct

FCbCustomById

A custom compact binary field type with an integer identifier.

Public struct

FCbCustomByName

A custom compact binary field type with a string identifier.

Public class

FCbField

A field that includes a shared buffer for the memory that contains it.

Public class

FCbFieldIterator

Iterator for FCbField.

Public class

FCbFieldType

Functions that operate on ECbFieldType.

Public class

FCbFieldView

An atom of data in the compact binary format.

Public class

FCbFieldViewIterator

Iterator for FCbFieldView.

Public class

FCbIteratorSentinel

Iterator that can be used as a sentinel for the end of a range.

Public class

FCbObject

An object that includes a shared buffer for the memory that contains it.

Public class

FCbObjectId

An opaque 12-byte object identifier.

Public class

FCbObjectView

Array of FCbField[View] that have unique names.

Public class

FCbPackage

A package is an object with a tree of referenced attachments.

Public class

FCbValue

A type that provides unchecked access to compact binary values.

Public class

FCbWriter

A writer for compact binary object, arrays, and fields.

Public struct

FCompressedChunkInfo

Implements a helper structure for compression support

Public class

FCurrentCustomVersions

Provides access to code-defined custom versions registered via FCustomVersionRegistration.

Public struct

FCustomVersion

Structure to hold unique custom key with its version.

Public class

FCustomVersionContainer

Container for all available/serialized custom versions.

Public struct

FCustomVersionDifference

Public class

FCustomVersionRegistration

This class will cause the registration of a custom version number and key with the global FCustomVersionContainer when instantiated, and unregister when destroyed.

Public struct

FElementId

Public struct

FFieldLayoutDesc

Public struct

FFileRegion

Represents a region of logically related bytes within a larger block of cooked data.

Public struct

FFrozenMemoryImagePtr

Public class

FHashedName

Public struct

FHashedNameDebugString

Public struct

FIntegerParams

Parameters for converting to an integer.

Public class

FLargeMemoryData

Data storage for the large memory reader and writer.

Public class

FLargeMemoryReader

Archive for reading a large amount of arbitrary data from memory

Public class

FLargeMemoryWriter

Archive for storing a large amount of arbitrary data to memory

Public class

FMappedName

Index and name number into a name map.

Public class

FMemoryArchive

Base class for serializing arbitrary data in memory.

Public class

FMemoryImage

Public class

FMemoryImageAllocatorBase

Public struct

FMemoryImageNamePointer

Public struct

FMemoryImageResult

Public class

FMemoryImageSection

Public class

FMemoryImageString

Public struct

FMemoryImageVTablePointer

Public class

FMemoryImageWriter

Public class

FMemoryReader

Archive for reading arbitrary data from the specified memory location

Public class

FMemoryReaderView

Archive for reading arbitrary data from the specified memory view

Public struct

FMemoryToStringContext

Public class

FMemoryUnfreezeContent

Public class

FMemoryWriter

FMemoryWriter and FMemoryWriter64 are implemented as derived classes rather than aliases so that forward declarations will work.

Public class

FMemoryWriter64

Public struct

FNameAsStringIndexProxyArchive

Implements a proxy archive that serializes FNames as string data or an index (if the same name is repeated).

Public struct

FNameAsStringProxyArchive

Implements a proxy archive that serializes FNames as string data.

Public class

FNameMap

Maps serialized name entries to names.

Public struct

FPlatformTypeLayoutParameters

Public class

FPointerTableBase

Public class

FPtrTableBase

Public struct

FRegisterTypeLayoutDesc

Public class

FSlotBase

The base class of all slot types.

Public class

FSlotPosition

Represents a position of a slot within the hierarchy.

Public class

FStaticMemoryReader

Archive for reading arbitrary data from the specified memory location

Public class

FStructuredArchive

Manages the state of an underlying FStructuredArchiveFormatter, and provides a consistent API for reading and writing to a structured archive.

Public class

FStructuredArchiveArray

Represents an array in the structured archive.

Public class

FStructuredArchiveChildReader

FStructuredArchiveChildReader

Public class

FStructuredArchiveFormatter

Interface to format data to and from an underlying archive.

Public class

FStructuredArchiveFromArchive

Public class

FStructuredArchiveMap

Represents a map in the structured archive.

Public class

FStructuredArchiveRecord

Represents a record in the structured archive.

Public class

FStructuredArchiveSlot

Contains a value in the archive; either a field or array/map element.

Public class

FStructuredArchiveStream

Represents an unsized sequence of slots in the structured archive (similar to an array, but without a known size).

Public struct

FTypeLayoutDesc

Public class

FVoidPtrTable

Public class

ICookedPackageWriter

Interface for cooking that writes cooked packages to storage usable by the runtime game.

Public class

IPackageWriter

Interface for SavePackage to write packages to storage.

Public class

TCbBuffer

A wrapper that holds a reference to the buffer that contains its compact binary value.

Public class

TCbBufferFactory

Factory functions for types derived from TCbBuffer.

Public class

TCbFieldIterator

Iterator for FCbField[View] that can operate on any contiguous range of fields.

Public class

TCbWriter

A writer for compact binary object, arrays, and fields that uses a fixed-size stack buffer.

Public class

TCheckedObjPtr

TCheckedObjPtr

Public struct

TGetBaseTypeHelper

Public struct

TGetDefaultObjectHelper

Public struct

TGetFreezeImageFieldHelper

Public struct

TGetFreezeImageHelper

Public struct

TGetTypeLayoutHelper

Public struct

THasCustomDefaultObject

Public struct

THasTypeLayout

Public class

TIndexedPtrBase

That IndexedPtr types don't declare a default intrinsic type layout.

Public struct

TInitializeBaseHelper

Public class

TMemoryHasher

Archive for hashing arbitrary data

Public class

TMemoryImageAllocator

Public struct

TMemoryImageObject

Public class

TMemoryImagePtr

Public class

TMemoryWriter

Archive for storing arbitrary data to the specified memory location

Public struct

TNamedAttribute

Class to contain a named attribute for serialization.

Public struct

TNamedValue

Class to contain a named value for serialization.

Public struct

TOptionalNamedAttribute

Class to contain a named attribute for serialization, with a default.

Public class

TPatchedPtrBase

Public struct

TProvidesStaticStruct

Public class

TPtrTable

Public class

TPtrTableBase

Public class

TRefCountPtrTable

Public struct

TStaticGetTypeLayoutHelper

Public class

TUniqueMemoryImagePtr

Public struct

TUsePropertyFreezing

Public struct

TValidateInterfaceHelper

Typedefs

Name

Description

CustomVersionValidatorFunc

FArchiveFormatterType

Typedef for which formatter type to support

FArrayWriter

Archive objects that are also a TArray.

FCbBufferAllocator

A reference to a function that is used to allocate buffers for compact binary data.

FCbFieldVisitor

A reference to a function that is used to visit fields.

FCustomVersionArray

FExternalReadCallback

FMemoryHasherBlake3

FMemoryHasherSHA1

FMemoryImageAllocator

FMemoryImageObject

FMemoryImageSetAllocator

FMemoryImageSparseArrayAllocator

TIndexedPtr

TIndexedRefCountPtr

TMemoryImageArray

TMemoryImageMap

TMemoryImageSet

TPatchedPtr

TPatchedRefCountPtr

Enums

Name

Description

Public enum

EArchiveValueType

Specifies the type of a value in a slot. Used by FContextFreeArchiveFormatter for introspection.

Public enum

EBufferWriterFlags

Public enum

ECbFieldError

Errors that can occur when accessing a field.

Public enum

ECbFieldType

Field types and flags for FCbField[View].

Public enum

ECbValidateError

Flags for compact binary validation errors. Multiple flags may be combined.

Public enum

ECbValidateMode

Flags for validating compact binary data.

Public enum

ECustomVersionDifference

Public enum

EFieldLayoutFlags::Type

Public enum

EFileRegionType

Describes the type of data found in a given file region.

Public enum

ELargeMemoryReaderFlags

Public enum

ETypeLayoutInterface::Type

Public enum

StructuredArchive_Private::EElementType

Public enum

StructuredArchive_Private::EEnteringAttributeState

Functions

Name Description

Public function

void

 

appBitsCpy

(
    uint8* Dest,
    int32 DestBit,
    uint8* Src,
    int32 SrcBit,
    int32 BitCount
)

Public function

T

 

Arctor

(
    FArchive& Ar
)

Template for archive constructors.

Public function

void

 

CompactBinaryToJson

(
    const FCbObjectView& Object,
    FUtf8StringBuilderBase& Builder
)

Public function

void

 

CopyFormattedData

(
    FStructuredArchiveFormatter& Input...,
    FStructuredArchiveFormatter& Outpu...
)

Copies formatted data from one place to another.

Public function

void

 

DeleteObjectFromLayout

(
    T* Object,
    const FPointerTableBase* PtrTa...,
    bool bIsFrozen
)

Public function

Type

 

EFieldLayoutFlags::MakeFlags

(
    uint32 Flags
)

Public function

Type

 

EFieldLayoutFlags::MakeFlagsEditorOnly

(
    uint32 Flags
)

Public function

Type

 

EFieldLayoutFlags::MakeFlagsRayTracing

(
    uint32 Flags
)

Public function

bool

 

ETypeLayoutInterface::HasVTable

(
    Type InType
)

Public function

uint32

 

Freeze::AppendHash

(
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::AppendHashForNameAndSize

(
    const TCHAR* Name,
    uint32 Size,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::AppendHashPair

(
    const FTypeLayoutDesc& KeyTypeDesc,
    const FTypeLayoutDesc& ValueTypeDe...,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::DefaultAppendHash

(
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::DefaultGetTargetAlignment

(
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...
)

Public function

void

 

Freeze::DefaultToString

(
    const void* Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

uint32

 

Freeze::DefaultUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const void* Object,
    const FTypeLayoutDesc& TypeDesc,
    void* OutDst
)

Public function

void

 

Freeze::DefaultWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const void* Object,
    const FTypeLayoutDesc& TypeDesc,
    const FTypeLayoutDesc& DerivedType...
)

Public function

void

 

Freeze::DefaultWriteMemoryImageField

(
    FMemoryImageWriter& Writer,
    const void* Object,
    const void* FieldObject,
    const FTypeLayoutDesc& TypeDesc,
    const FTypeLayoutDesc& DerivedType...
)

Public function

void

 

Freeze::DestroyObject

(
    T* Object,
    const FPointerTableBase* PtrTa...,
    bool bIsFrozen
)

Override for types that need access to a PointerTable in order to destroy frozen data WARNING! Frozen data may have deduplicated portions, so it's possible that a given object may have multiple references Any attempt to cleanup/destroy frozen data must take care to safely allow DestroyObject to be called multiple times on the same frozen object Generally speaking, it's NOT safe to invoke the built-in destructor multiple times

Public function

void

 

Freeze::ExtractBitFieldValue

(
    const void* Value,
    uint32 SrcBitOffset,
    uint32 DestBitOffset,
    uint32 NumBits,
    uint64& InOutValue
)

Helper functions

Public function

uint8

 

Freeze::FindFieldNameLength

(
    const TCHAR* Name
)

Finds the length of the field name, omitting any _DEPRECATED suffix.

Public function

uint32

 

Freeze::GetTargetAlignment

(
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...
)

Public function

uint32

 

Freeze::HashLayout

(
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHAHash& OutHash
)

Public function

FSHAHash

 

Freeze::HashLayout

(
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...
)

Public function

uint32

 

Freeze::HashLayouts

(
    const TArray< const FTypeLayoutDesc...,
    const FPlatformTypeLayoutParameters...,
    FSHAHash& OutHash
)

Public function

bool

 

Freeze::IncludeField

(
    const FFieldLayoutDesc* FieldD...,
    const FPlatformTypeLayoutParameters...
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    void*const* DummyObject,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const T* DummyObject,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const TIndexedPtrBase< T, PtrType >...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const TMemoryImagePtr< T >* Du...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::IntrinsicGetTargetAlignment

(
    const TIndexedPtrBase< T, PtrType >...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...
)

Public function

uint32

 

Freeze::IntrinsicGetTargetAlignment

(
    const TMemoryImagePtr< T >* Du...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...
)

Public function

uint32

 

Freeze::IntrinsicGetTargetAlignment

(
    void*const* DummyObject,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...
)

Public function

uint32

 

Freeze::IntrinsicGetTargetAlignment

(
    const T* DummyObject,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...
)

Public function

void

 

Freeze::IntrinsicToString

(
    void* Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    const TMemoryImagePtr< T >& Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    const FHashedName& Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    const T& Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    char Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    int Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    int8 Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    long Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    long long Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    short Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    unsigned short Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    unsigned int Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    unsigned long Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    unsigned long long Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    float Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    double Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    wchar_t Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    unsigned char Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    char16_t Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

uint32

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const T& Object,
    void* OutDst
)

Public function

uint32

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const FHashedNameDebugString& Obje...,
    void* OutDst
)

Public function

uint32

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const TMemoryImagePtr< T >& Object,
    void* OutDst
)

Public function

uint32

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const TIndexedPtrBase< T, PtrType >...,
    void* OutDst
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const TMemoryImagePtr< T >& Object,
    const FTypeLayoutDesc&
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const TIndexedPtrBase< T, PtrType >...,
    const FTypeLayoutDesc& TypeDesc
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const void* Object,
    uint32 Size
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    void*,
    const FTypeLayoutDesc&
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const T& Object,
    const FTypeLayoutDesc& TypeDesc
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const FHashedNameDebugString& Obje...,
    const FTypeLayoutDesc&
)

Public function

FMemoryImage...

 

FreezeMemoryImageObject

(
    const void* Object,
    const FTypeLayoutDesc& TypeDesc,
    FPointerTableBase* PointerTabl...
)

Public function

uint32

 

GetBaseOffset()

Public function

const T *...

 

GetDefault()

Get default object of a class.

Public function

uint32

 

GetTypeHash

(
    const FCbObjectId& Id
)

Public function

uint32

 

GetTypeHash

(
    const FCbAttachment& Attachment
)

Hashes attachments by their hash. Any discrepancy in type must be handled externally.

Public function

uint32

 

GetTypeHash

(
    const FMemoryImageString& S
)

Case insensitive string hash function.

Public function

const FTypeL...

 

GetTypeLayoutDesc

(
    const FPointerTableBase*,
    const T& Object
)

Public function

void

 

InternalDeleteObjectFromLayout

(
    void* Object,
    const FTypeLayoutDesc& TypeDesc,
    const FPointerTableBase* PtrTa...,
    bool bIsFrozen
)

Public function

TEnableIf<&#...

 

InternalGetDefaultObject()

Public function

TEnableIf< T...

 

InternalGetDefaultObject()

Public function Static

void

 

InternalInitializeBaseHelper

(
    FTypeLayoutDesc& TypeDesc
)

Public function Static

void

 

InternalInitializeBasesHelper

(
    FTypeLayoutDesc& TypeDesc
)

Public function Static

void

 

InternalInitializeBasesHelper

(
    FTypeLayoutDesc& TypeDesc
)

Public function Static

const ANSICH...

 

LexToString

(
    IPackageWriter::FBulkDataInfo::ETyp...
)

Public function

FCbField

 

LoadCompactBinary

(
    FArchive& Ar,
    FCbBufferAllocator Allocator
)

Load a compact binary field from an archive.

Public function

TNamedAttrib...

 

MakeNamedAttribute

(
    FArchiveFieldName Name,
    T& Value
)

Helper function to construct a TNamedAttribute, deducing the value type.

Public function

TNamedValue<...

 

MakeNamedValue

(
    FArchiveFieldName Name,
    T& Value
)

Helper function to construct a TNamedValue, deducing the value type.

Public function

TOptionalNam...

 

MakeOptionalNamedAttribute

(
    FArchiveFieldName Name,
    T& Value,
    const typename TIdentity< T >::Type...
)

Helper function to construct a TOptionalNamedAttribute, deducing the value type.

Public function

uint64

 

MeasureCompactBinary

(
    FMemoryView View,
    ECbFieldType Type
)

Determine the size in bytes of the compact binary field at the start of the view.

Public function

uint32

 

MeasureVarInt

(
    const void* InData
)

Measure the length in bytes (1-9) of an encoded variable-length integer.

Public function

uint32

 

MeasureVarInt

(
    int32 InValue
)

Measure the number of bytes (1-5) required to encode the 32-bit input.

Public function

uint32

 

MeasureVarInt

(
    int64 InValue
)

Measure the number of bytes (1-9) required to encode the 64-bit input.

Public function

uint32

 

MeasureVarUInt

(
    uint64 InValue
)

Measure the number of bytes (1-9) required to encode the 64-bit input.

Public function

uint32

 

MeasureVarUInt

(
    uint32 InValue
)

Measure the number of bytes (1-5) required to encode the 32-bit input.

Public function

uint32

 

MeasureVarUInt

(
    const void* InData
)

Variable-Length Integer Encoding

Public function

constexpr bo...

 

operator!

(
    EBufferWriterFlags E
)

Public function

constexpr bo...

 

operator!

(
    ECbFieldType E
)

Public function

constexpr bo...

 

operator!

(
    ECbValidateMode E
)

Public function

constexpr bo...

 

operator!

(
    ECbValidateError E
)

Public function

constexpr bo...

 

operator!

(
    ELargeMemoryReaderFlags E
)

Public function

constexpr bo...

 

operator!

(
    IPackageWriter::EWriteOptions E
)

Public function

bool

 

operator!=

(
    const FCbObjectId& A,
    const FCbObjectId& B
)

Public function

bool

 

operator!=

(
    const FMemoryImageVTablePointer& L...,
    const FMemoryImageVTablePointer& R...
)

Public function

bool

 

operator!=

(
    const FMemoryImageNamePointer& Lhs,
    const FMemoryImageNamePointer& Rhs
)

Public function

bool

 

operator!=

(
    const FTypeLayoutDesc& Lhs,
    const FTypeLayoutDesc& Rhs
)

Public function

constexpr EB...

 

operator&

(
    EBufferWriterFlags Lhs,
    EBufferWriterFlags Rhs
)

Public function

constexpr EC...

 

operator&

(
    ECbValidateMode Lhs,
    ECbValidateMode Rhs
)

Public function

constexpr EL...

 

operator&

(
    ELargeMemoryReaderFlags Lhs,
    ELargeMemoryReaderFlags Rhs
)

Public function

constexpr IP...

 

operator&

(
    IPackageWriter::EWriteOptions Lhs,
    IPackageWriter::EWriteOptions Rhs
)

Public function

constexpr EC...

 

operator&

(
    ECbValidateError Lhs,
    ECbValidateError Rhs
)

Public function

constexpr EC...

 

operator&

(
    ECbFieldType Lhs,
    ECbFieldType Rhs
)

Public function

ECbValidateE...

 

operator&=

(
    ECbValidateError& Lhs,
    ECbValidateError Rhs
)

Public function

ECbValidateM...

 

operator&=

(
    ECbValidateMode& Lhs,
    ECbValidateMode Rhs
)

Public function

ELargeMemory...

 

operator&=

(
    ELargeMemoryReaderFlags& Lhs,
    ELargeMemoryReaderFlags Rhs
)

Public function

IPackageWrit...

 

operator&=

(
    IPackageWriter::EWriteOptions& Lhs,
    IPackageWriter::EWriteOptions Rhs
)

Public function

ECbFieldType...

 

operator&=

(
    ECbFieldType& Lhs,
    ECbFieldType Rhs
)

Public function

EBufferWrite...

 

operator&=

(
    EBufferWriterFlags& Lhs,
    EBufferWriterFlags Rhs
)

Public function

constexpr IP...

 

operator^

(
    IPackageWriter::EWriteOptions Lhs,
    IPackageWriter::EWriteOptions Rhs
)

Public function

constexpr EL...

 

operator^

(
    ELargeMemoryReaderFlags Lhs,
    ELargeMemoryReaderFlags Rhs
)

Public function

constexpr EC...

 

operator^

(
    ECbValidateMode Lhs,
    ECbValidateMode Rhs
)

Public function

constexpr EC...

 

operator^

(
    ECbFieldType Lhs,
    ECbFieldType Rhs
)

Public function

constexpr EB...

 

operator^

(
    EBufferWriterFlags Lhs,
    EBufferWriterFlags Rhs
)

Public function

constexpr EC...

 

operator^

(
    ECbValidateError Lhs,
    ECbValidateError Rhs
)

Public function

ECbFieldType...

 

operator^=

(
    ECbFieldType& Lhs,
    ECbFieldType Rhs
)

Public function

ECbValidateM...

 

operator^=

(
    ECbValidateMode& Lhs,
    ECbValidateMode Rhs
)

Public function

ECbValidateE...

 

operator^=

(
    ECbValidateError& Lhs,
    ECbValidateError Rhs
)

Public function

IPackageWrit...

 

operator^=

(
    IPackageWriter::EWriteOptions& Lhs,
    IPackageWriter::EWriteOptions Rhs
)

Public function

EBufferWrite...

 

operator^=

(
    EBufferWriterFlags& Lhs,
    EBufferWriterFlags Rhs
)

Public function

ELargeMemory...

 

operator^=

(
    ELargeMemoryReaderFlags& Lhs,
    ELargeMemoryReaderFlags Rhs
)

Public function

constexpr IP...

 

operator|

(
    IPackageWriter::EWriteOptions Lhs,
    IPackageWriter::EWriteOptions Rhs
)

Public function

constexpr EL...

 

operator|

(
    ELargeMemoryReaderFlags Lhs,
    ELargeMemoryReaderFlags Rhs
)

Public function

constexpr EC...

 

operator|

(
    ECbValidateError Lhs,
    ECbValidateError Rhs
)

Public function

constexpr EC...

 

operator|

(
    ECbValidateMode Lhs,
    ECbValidateMode Rhs
)

Public function

constexpr EC...

 

operator|

(
    ECbFieldType Lhs,
    ECbFieldType Rhs
)

Public function

constexpr EB...

 

operator|

(
    EBufferWriterFlags Lhs,
    EBufferWriterFlags Rhs
)

Public function

EBufferWrite...

 

operator|=

(
    EBufferWriterFlags& Lhs,
    EBufferWriterFlags Rhs
)

Public function

ECbFieldType...

 

operator|=

(
    ECbFieldType& Lhs,
    ECbFieldType Rhs
)

Public function

ECbValidateM...

 

operator|=

(
    ECbValidateMode& Lhs,
    ECbValidateMode Rhs
)

Public function

IPackageWrit...

 

operator|=

(
    IPackageWriter::EWriteOptions& Lhs,
    IPackageWriter::EWriteOptions Rhs
)

Public function

ELargeMemory...

 

operator|=

(
    ELargeMemoryReaderFlags& Lhs,
    ELargeMemoryReaderFlags Rhs
)

Public function

ECbValidateE...

 

operator|=

(
    ECbValidateError& Lhs,
    ECbValidateError Rhs
)

Public function

constexpr EL...

 

operator~

(
    ELargeMemoryReaderFlags E
)

Public function

constexpr EC...

 

operator~

(
    ECbValidateMode E
)

Public function

constexpr EC...

 

operator~

(
    ECbFieldType E
)

Public function

constexpr EB...

 

operator~

(
    EBufferWriterFlags E
)

Public function

constexpr EC...

 

operator~

(
    ECbValidateError E
)

Public function

constexpr IP...

 

operator~

(
    IPackageWriter::EWriteOptions E
)

Public function

bool

 

operator==

(
    const FCbObjectId& A,
    const FCbObjectId& B
)

Public function

bool

 

operator==

(
    const FMemoryImageVTablePointer& L...,
    const FMemoryImageVTablePointer& R...
)

Public function

bool

 

operator==

(
    const FMemoryImageNamePointer& Lhs,
    const FMemoryImageNamePointer& Rhs
)

Public function

bool

 

operator==

(
    const FTypeLayoutDesc& Lhs,
    const FTypeLayoutDesc& Rhs
)

Public function

int64

 

ReadVarInt

(
    const void* InData,
    uint32& OutByteCount
)

Read a variable-length signed integer.

Public function

int64

 

ReadVarIntFromArchive

(
    FArchive& Ar
)

Public function

uint64

 

ReadVarUInt

(
    const void* InData,
    uint32& OutByteCount
)

Read a variable-length unsigned integer.

Public function

uint64

 

ReadVarUIntFromArchive

(
    FArchive& Ar
)

Public function

void

 

SaveCompactBinary

(
    FArchive& Ar,
    const FCbArrayView& Array
)

Public function

void

 

SaveCompactBinary

(
    FArchive& Ar,
    const FCbObjectView& Object
)

Public function

void

 

SaveCompactBinary

(
    FArchive& Ar,
    const FCbFieldView& Field
)

Save a compact binary value to an archive.

Public function

void

 

SerializeVarInt

(
    FArchive& Ar,
    int64& Value
)

Public function

void

 

SerializeVarUInt

(
    FArchive& Ar,
    uint64& Value
)

Public function

const FTypeL...

 

StaticGetTypeLayoutDesc()

Public function

bool

 

TryMeasureCompactBinary

(
    FMemoryView InView,
    ECbFieldType& OutType,
    uint64& OutSize,
    ECbFieldType InType
)

Try to determine the type and size of the compact binary field at the start of the view.

Public function Static

constexpr FI...

 

UE::CompactBinary::Private::MakeIntegerParams()

Make integer params for the given integer type.

Public function Static

constexpr T

 

UE::CompactBinary::Private::ReadUnaligned

(
    const void*const Memory
)

Public function

void *

 

UnfreezeMemoryImageObject

(
    const void* FrozenObject,
    const FTypeLayoutDesc& TypeDesc,
    const FPointerTableBase* Point...
)

Public function

ECbValidateE...

 

ValidateCompactBinary

(
    const FCbField& Value,
    ECbValidateMode Mode
)

Validate the compact binary data for one value as specified by the mode flags.

Public function

ECbValidateE...

 

ValidateCompactBinary

(
    const FCbArray& Value,
    ECbValidateMode Mode
)

Public function

ECbValidateE...

 

ValidateCompactBinary

(
    const FCbObject& Value,
    ECbValidateMode Mode
)

Public function

ECbValidateE...

 

ValidateCompactBinary

(
    const FCbPackage& Value,
    ECbValidateMode Mode
)

Public function

ECbValidateE...

 

ValidateCompactBinary

(
    FMemoryView View,
    ECbValidateMode Mode,
    ECbFieldType Type
)

Validate the compact binary data for one field in the view as specified by the mode flags.

Public function

ECbValidateE...

 

ValidateCompactBinary

(
    const FCbAttachment& Value,
    ECbValidateMode Mode
)

Public function

ECbValidateE...

 

ValidateCompactBinaryAttachment

(
    FMemoryView View,
    ECbValidateMode Mode
)

Validate the compact binary attachment pointed to by the view as specified by the mode flags.

Public function

ECbValidateE...

 

ValidateCompactBinaryPackage

(
    FMemoryView View,
    ECbValidateMode Mode
)

Validate the compact binary package pointed to by the view as specified by the mode flags.

Public function

ECbValidateE...

 

ValidateCompactBinaryRange

(
    FMemoryView View,
    ECbValidateMode Mode
)

Validate the compact binary data for every field in the view as specified by the mode flags.

Public function

uint32

 

WriteVarInt

(
    int32 InValue,
    void* OutData
)

Write a variable-length signed integer.

Public function

uint32

 

WriteVarInt

(
    int64 InValue,
    void* OutData
)

Write a variable-length signed integer.

Public function

void

 

WriteVarIntToArchive

(
    FArchive& Ar,
    int64 Value
)

Public function

uint32

 

WriteVarUInt

(
    uint32 InValue,
    void* OutData
)

Write a variable-length unsigned integer.

Public function

uint32

 

WriteVarUInt

(
    uint64 InValue,
    void* OutData
)

Write a variable-length unsigned integer.

Public function

void

 

WriteVarUIntToArchive

(
    FArchive& Ar,
    uint64 Value
)

Variables

Name Description

Public variable

TAutoConsoleVar...

 

CVarMaxNetStringSize

CVar specifying the maximum serialization size for strings sent/received by the netcode