Navigation
API > API/Runtime > API/Runtime/Core
Manages the state of an underlying FStructuredArchiveFormatter, and provides a consistent API for reading and writing to a structured archive.
Both reading and writing to the archive are forward only from an interface point of view. There is no point at which it is possible to require seeking.
| Name | FStructuredArchive |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Serialization/StructuredArchive.h |
| Include Path | #include "Serialization/StructuredArchive.h" |
Syntax
class FStructuredArchive
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStructuredArchive
(
FArchiveFormatterType& InFormatter |
Constructor. | Serialization/StructuredArchive.h | |
FStructuredArchive
(
const FStructuredArchive& |
Serialization/StructuredArchive.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FStructuredArchive() |
Default destructor. Closes the archive. | Serialization/StructuredArchive.h |
Structs
| Name | Remarks |
|---|---|
| FElement | |
| FIdGenerator |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FArray | FStructuredArchiveArray | Serialization/StructuredArchive.h | |
| FMap | FStructuredArchiveMap | Serialization/StructuredArchive.h | |
| FRecord | FStructuredArchiveRecord | Serialization/StructuredArchive.h | |
| FSlot | FStructuredArchiveSlot | Serialization/StructuredArchive.h | |
| FStream | FStructuredArchiveStream | Serialization/StructuredArchive.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bRequiresStructuralMetadata | const bool | Whether the formatter requires structural metadata. | Serialization/StructuredArchive.h | |
| CurrentEnteringAttributeState | UE::StructuredArchive::Private::EEnteringAttributeState | Whether or not we've just entered an attribute | Serialization/StructuredArchive.h | |
| CurrentScope | TArray< FElement, TNonRelocatableInlineAllocator< 32 > > | Tracks the current stack of objects being written. | Serialization/StructuredArchive.h | |
| CurrentSlotElementId | UE::StructuredArchive::Private::FElementId | The element ID assigned for the current slot. | Serialization/StructuredArchive.h | |
| ElementIdGenerator | FIdGenerator | The next element id to be assigned | Serialization/StructuredArchive.h | |
| Formatter | FArchiveFormatterType & | Reference to the formatter that actually writes out the data to the underlying archive | Serialization/StructuredArchive.h | |
| FStructuredArchiveArray | friend | Serialization/StructuredArchive.h | ||
| FStructuredArchiveMap | friend | Serialization/StructuredArchive.h | ||
| FStructuredArchiveRecord | friend | Serialization/StructuredArchive.h | ||
| FStructuredArchiveSlot | friend | Serialization/StructuredArchive.h | ||
| FStructuredArchiveStream | friend | Serialization/StructuredArchive.h | ||
| RootElementId | UE::StructuredArchive::Private::FElementId | The ID of the root element. | Serialization/StructuredArchive.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Close() |
Flushes any remaining scope to the underlying formatter and closes the archive. | Serialization/StructuredArchive.h | |
const FArchiveState & GetArchiveState() |
Gets the archiving state. | Serialization/StructuredArchive.h | |
FArchive & GetUnderlyingArchive() |
Gets the serialization context from the underlying archive. | Serialization/StructuredArchive.h | |
FStructuredArchiveSlot Open() |
Start writing to the archive, and gets an interface to the root slot. | Serialization/StructuredArchive.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStructuredArchive & operator=
(
const FStructuredArchive& |
Serialization/StructuredArchive.h |