1. Epic GamesDeveloper
  3. Serialization

Serialization

API > API/Runtime > API/Runtime/Core

Filters

Classes

  Type 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 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 FArchiveCookData Holds archive data only relevant for cooking archives.  
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 FBufferArchive and FBufferArchive64 are implemented as derived classes rather than aliases so that forward declarations will work.  
Public class FBufferArchive64    
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 Value of this struct should never be a valid unfrozen pointer (i.e. a memory address).  
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 FPackageHashes Struct containing hashes computed during cooked package writing.  
Public struct FPlatformTypeLayoutParameters    
Public class FPointerTableBase    
Public class FPooledLargeMemoryData Pooled storage of FLargeMemoryData instances, allowing allocation-free and lock-free access.  
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 TBufferArchive Buffer archiver.  
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 Note 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 class TPtrTable    
Public class TPtrTableBase    
Public class TRefCountPtrTable    
Public struct TStaticGetTypeLayoutHelper    
Public class TUniqueMemoryImagePtr    
Public struct TUsePropertyFreezing    
Public struct TValidateInterfaceHelper    

Enums

  Type Name Description
Public enum EFieldLayoutFlags::Type    
Public enum ETypeLayoutInterface::Type    
Public enum UE::StructuredArchive::Private::EElementType    
Public enum UE::StructuredArchive::Private::EEnteringAttributeState    

Functions

  Type Name Description
Public function Type

EFieldLayoutFlags::MakeFlags ( uint32 Flags
)

  
Public function Type  
Public function Type  
Public function bool  
Public function uint32

Freeze::AppendHash ( const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

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

  
Public function uint32

Freeze::AppendHashPair ( const FTypeLayoutDesc& KeyTypeDesc,
const FTypeLayoutDesc& ValueTypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::DefaultAppendHash ( const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32  
Public function void

Freeze::DefaultToString ( const void* Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function uint32

Freeze::DefaultUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const void* Object,
const FTypeLayoutDesc& TypeDesc,
void* OutDst
)

  
Public function void

Freeze::DefaultWriteMemoryImage ( FMemoryImageWriter& Writer,
const void* Object,
const FTypeLayoutDesc& TypeDesc,
const FTypeLayoutDesc& DerivedTypeDesc
)

  
Public function void

Freeze::DefaultWriteMemoryImageField ( FMemoryImageWriter& Writer,
const void* Object,
const void* FieldObject,
const FTypeLayoutDesc& TypeDesc,
const FTypeLayoutDesc& DerivedTypeDesc
)

  
Public function void

Freeze::DestroyObject ( T* Object,
const FPointerTableBase* PtrTable,
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  
Public function uint32

Freeze::HashLayout ( const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHAHash& OutHash
)

  
Public function FSHAHash

Freeze::HashLayout ( const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams
)

  
Public function uint32

Freeze::HashLayouts ( const TArray< const FTypeLayoutDesc* >& TypeLayouts,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHAHash& OutHash
)

  
Public function bool

Freeze::IncludeField ( const FFieldLayoutDesc* FieldDesc,
const FPlatformTypeLayoutParameters& LayoutParams
)

  
Public function uint32

Freeze::IntrinsicAppendHash ( const T* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::IntrinsicAppendHash ( const TIndexedPtrBase< T, PtrType >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::IntrinsicAppendHash ( const TMemoryImagePtr< T >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::IntrinsicAppendHash ( void*const* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::IntrinsicGetTargetAlignment ( const TMemoryImagePtr< T >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams
)

  
Public function uint32

Freeze::IntrinsicGetTargetAlignment ( const TIndexedPtrBase< T, PtrType >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams
)

  
Public function uint32

Freeze::IntrinsicGetTargetAlignment ( const T* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams
)

  
Public function uint32

Freeze::IntrinsicGetTargetAlignment ( void*const* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams
)

  
Public function void

Freeze::IntrinsicToString ( long long Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( wchar_t Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( double Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( float Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( unsigned long long Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( unsigned long Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( unsigned int Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( unsigned short Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( unsigned char Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( long Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( int8 Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( int Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( char Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( char16_t Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( const T& Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( const FHashedName& Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( const TMemoryImagePtr< T >& Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( short Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function void

Freeze::IntrinsicToString ( void* Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function uint32

Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const TMemoryImagePtr< T >& Object,
void* OutDst
)

  
Public function uint32

Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const FHashedNameDebugString& Object,
void* OutDst
)

  
Public function uint32

Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const TIndexedPtrBase< T, PtrType >& Object,
void* OutDst
)

  
Public function uint32

Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const T& Object,
void* OutDst
)

  
Public function void  
Public function void  
Public function void

Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer,
const TIndexedPtrBase< T, PtrType >& Object,
const FTypeLayoutDesc& TypeDesc
)

  
Public function void

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

  
Public function void

Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer,
const T& Object,
const FTypeLayoutDesc& TypeDesc
)

  
Public function void  
Public function Static constexpr FIntegerParams Make integer params for the given integer type.
Public function FElementId  
Public function FArchiveFormatterType &  
Public function FArchive &  
Public function FArchiveState &  
Public function TNamedAttribute< T >  
Public function TNamedValue< T >  
Public function TOptionalNamedAttribute< T >

UE::StructuredArchive::Private::MakeOptionalNamedAttribute ( FArchiveFieldName Name,
T& Value,
const typename TIdentity< T >::Type& Default
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page