FStructuredArchive

Manages the state of an underlying [FStructuredArchiveFormatter](API\Runtime\Core\Serialization\FStructuredArchiveFormatter), and provides a consistent API for reading and writing to a structured archive.

Windows
MacOS
Linux

References

Module

Core

Header

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

Include

#include "Serialization/StructuredArchive.h"

Syntax

class FStructuredArchive

Remarks

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.

Constructors

Name Description

Public function

FStructuredArchive

(
    FArchiveFormatterType& InFormatter
)

Constructor.

Public function

FStructuredArchive

(
    const FStructuredArchive&
)

Destructors

Name Description

Public function

~FStructuredArchive()

Default destructor. Closes the archive.

Functions

Name Description

Public function

void

 

Close()

Flushes any remaining scope to the underlying formatter and closes the archive.

Public function

FArchive &

 

GetUnderlyingArchive()

Gets the serialization context from the underlying archive.

Public function

FSlot

 

Open()

Start writing to the archive, and gets an interface to the root slot.

Operators

Name Description

Public function

FStructuredA...

 

operator=

(
    const FStructuredArchive&
)

Classes

Name

Description

Public class

FArray

Represents an array in the structured archive.

Public struct

FContainer

Public class

FMap

Represents a map in the structured archive.

Public class

FRecord

Represents a record in the structured archive.

Public class

FSlot

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

Public class

FStream

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

Enums

Name

Description

Private enum

EElementType

Constants

Name

Description

RootElementId

First element ID, which is assigned to the root element.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback