FStructuredArchive Class Reference

#include <StructuredArchive.h>

Public Types
using	FSlot = FStructuredArchiveSlot
using	FRecord = FStructuredArchiveRecord
using	FArray = FStructuredArchiveArray
using	FStream = FStructuredArchiveStream
using	FMap = FStructuredArchiveMap

Public Member Functions
UE_API	FStructuredArchive (FArchiveFormatterType &InFormatter)
UE_API	~FStructuredArchive ()
UE_API FStructuredArchiveSlot	Open ()
UE_API void	Close ()
UE_FORCEINLINE_HINT FArchive &	GetUnderlyingArchive () const
UE_FORCEINLINE_HINT const FArchiveState &	GetArchiveState () const
	FStructuredArchive (const FStructuredArchive &)=delete
FStructuredArchive &	operator= (const FStructuredArchive &)=delete

Friends
class	FStructuredArchiveChildReader
UE::StructuredArchive::Private::FElementId	UE::StructuredArchive::Private::GetCurrentSlotElementIdImpl (FStructuredArchive &Ar)
FArchiveFormatterType &	UE::StructuredArchive::Private::GetFormatterImpl (FStructuredArchive &Ar)

Detailed Description

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.

Member Typedef Documentation

FArray

using FStructuredArchive::FArray = FStructuredArchiveArray

FMap

using FStructuredArchive::FMap = FStructuredArchiveMap

FRecord

using FStructuredArchive::FRecord = FStructuredArchiveRecord

FSlot

using FStructuredArchive::FSlot = FStructuredArchiveSlot

FStream

using FStructuredArchive::FStream = FStructuredArchiveStream

Constructor & Destructor Documentation

FStructuredArchive() [1/2]

UE_FORCEINLINE_HINT FStructuredArchive::FStructuredArchive ( FArchiveFormatterType &  InFormatter )

explicit

Constructor.

Parameters

InFormatter

Formatter for the archive data

~FStructuredArchive()

UE_FORCEINLINE_HINT FStructuredArchive::~FStructuredArchive

(

)

Default destructor. Closes the archive.

FStructuredArchive() [2/2]

FStructuredArchive::FStructuredArchive ( const FStructuredArchive &  )

delete

Member Function Documentation

Close()

UE_FORCEINLINE_HINT void FStructuredArchive::Close

(

)

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

GetArchiveState()

UE_FORCEINLINE_HINT const FArchiveState & FStructuredArchive::GetArchiveState ( ) const

inline

Gets the archiving state.

GetUnderlyingArchive()

UE_FORCEINLINE_HINT FArchive & FStructuredArchive::GetUnderlyingArchive ( ) const

inline

Gets the serialization context from the underlying archive.

Open()

UE_FORCEINLINE_HINT FStructuredArchiveSlot FStructuredArchive::Open

(

)

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

operator=()

FStructuredArchive & FStructuredArchive::operator= ( const FStructuredArchive &  )

delete

Friends And Related Symbol Documentation

FStructuredArchiveChildReader

friend class FStructuredArchiveChildReader

friend

UE::StructuredArchive::Private::GetCurrentSlotElementIdImpl

UE::StructuredArchive::Private::FElementId UE::StructuredArchive::Private::GetCurrentSlotElementIdImpl ( FStructuredArchive &  Ar )

friend

UE::StructuredArchive::Private::GetFormatterImpl

FArchiveFormatterType & UE::StructuredArchive::Private::GetFormatterImpl ( FStructuredArchive &  Ar )

friend

---

The documentation for this class was generated from the following file:

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