FStructuredArchiveFormatter

Interface to format data to and from an underlying archive.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Serialization/StructuredArchiveFormatter.h

Include

#include "Serialization/StructuredArchiveFormatter.h"

Syntax

class FStructuredArchiveFormatter

Remarks

Interface to format data to and from an underlying archive. Methods on this class are validated to be correct with the current archive state (eg. EnterObject/LeaveObject calls are checked to be matching), and do not need to be validated by implementations.

Any functions with the _TextOnly suffix are intended to be implemented when reading text archives that have a fully defined document tree, and allow querying additional properties that aren't available when reading from a pure binary archive. These functions will assert if called on a binary archive.

Destructors

Functions

Name Description

Public function Virtual

FStructuredA...

 

CreateSubtreeReader()

Public function

void

 

EnterArray

(
    int32& NumElements
)

Public function

void

 

EnterArrayElement()

Public function

void

 

EnterArrayElement_TextOnly

(
    EArchiveValueType& OutType
)

Public function

void

 

EnterAttribute

(
    FArchiveFieldName AttributeName
)

Public function

void

 

EnterAttributedValue()

Public function

void

 

EnterAttributedValueValue()

Public function

void

 

EnterField

(
    FArchiveFieldName Name
)

Public function

void

 

EnterField_TextOnly

(
    FArchiveFieldName Name,
    EArchiveValueType& OutType
)

Public function

void

 

EnterMap

(
    int32& NumElements
)

Public function

void

 

EnterMapElement

(
    FString& Name
)

Public function

void

 

EnterMapElement_TextOnly

(
    FString& Name,
    EArchiveValueType& OutType
)

Public function

void

 

EnterRecord()

Public function

void

 

EnterRecord_TextOnly

(
    TArray< FString >& OutFieldNames
)

Public function

void

 

EnterStream()

Public function

void

 

EnterStream_TextOnly

(
    int32& OutNumElements
)

Public function

void

 

EnterStreamElement()

Public function

void

 

EnterStreamElement_TextOnly

(
    EArchiveValueType& OutType
)

Public function

FArchive &

 

GetUnderlyingArchive()

Public function Const

bool

 

HasDocumentTree()

Public function

void

 

LeaveArray()

Public function

void

 

LeaveArrayElement()

Public function

void

 

LeaveAttribute()

Public function

void

 

LeaveAttributedValue()

Public function

void

 

LeaveField()

Public function

void

 

LeaveMap()

Public function

void

 

LeaveMapElement()

Public function

void

 

LeaveRecord()

Public function

void

 

LeaveStream()

Public function

void

 

LeaveStreamElement()

Public function

void

 

Serialize

(
    FLazyObjectPtr& Value
)

Public function

void

 

Serialize

(
    FSoftObjectPath& Value
)

Public function

void

 

Serialize

(
    FSoftObjectPtr& Value
)

Public function

void

 

Serialize

(
    FWeakObjectPtr& Value
)

Public function

void

 

Serialize

(
    FText& Value
)

Public function

void

 

Serialize

(
    UObject*& Value
)

Public function

void

 

Serialize

(
    FName& Value
)

Public function

void

 

Serialize

(
    FString& Value
)

Public function

void

 

Serialize

(
    bool& Value
)

Public function

void

 

Serialize

(
    double& Value
)

Public function

void

 

Serialize

(
    float& Value
)

Public function

void

 

Serialize

(
    int64& Value
)

Public function

void

 

Serialize

(
    int32& Value
)

Public function

void

 

Serialize

(
    int16& Value
)

Public function

void

 

Serialize

(
    int8& Value
)

Public function

void

 

Serialize

(
    uint64& Value
)

Public function

void

 

Serialize

(
    uint32& Value
)

Public function

void

 

Serialize

(
    uint16& Value
)

Public function

void

 

Serialize

(
    uint8& Value
)

Public function

void

 

Serialize

(
    TArray< uint8 >& Value
)

Public function

void

 

Serialize

(
    void* Data,
    uint64 DataSize
)

Public function

bool

 

TryEnterAttribute

(
    FArchiveFieldName AttributeName,
    bool bEnterWhenWriting
)

Public function

bool

 

TryEnterAttributedValueValue()

Public function

bool

 

TryEnterField

(
    FArchiveFieldName Name,
    bool bEnterWhenWriting
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss