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
	FStructuredArchive (FArchiveFormatterType &InFormatter)
	~FStructuredArchive ()
FStructuredArchiveSlot	Open ()
void	Close ()
FORCEINLINE FArchive &	GetUnderlyingArchive () const
FORCEINLINE const FArchiveState &	GetArchiveState () const
	FStructuredArchive (const FStructuredArchive &)=delete
FStructuredArchive &	operator= (const FStructuredArchive &)=delete

Private Attributes
friend	FStructuredArchiveSlot
friend	FStructuredArchiveRecord
friend	FStructuredArchiveArray
friend	FStructuredArchiveStream
friend	FStructuredArchiveMap
FArchiveFormatterType &	Formatter

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.

Definition at line 50 of file StructuredArchive.h.

Member Typedef Documentation

FArray

using FStructuredArchive::FArray = FStructuredArchiveArray

Definition at line 61 of file StructuredArchive.h.

FMap

using FStructuredArchive::FMap = FStructuredArchiveMap

Definition at line 63 of file StructuredArchive.h.

FRecord

using FStructuredArchive::FRecord = FStructuredArchiveRecord

Definition at line 60 of file StructuredArchive.h.

FSlot

using FStructuredArchive::FSlot = FStructuredArchiveSlot

Definition at line 59 of file StructuredArchive.h.

FStream

using FStructuredArchive::FStream = FStructuredArchiveStream

Definition at line 62 of file StructuredArchive.h.

Constructor & Destructor Documentation

FStructuredArchive() [1/2]

FORCEINLINE FStructuredArchive::FStructuredArchive ( FArchiveFormatterType & InFormatter )

explicit

Constructor.

Parameters

InFormatter

Formatter for the archive data

Definition at line 206 of file StructuredArchive.h.

~FStructuredArchive()

FORCEINLINE FStructuredArchive::~FStructuredArchive

(

)

Default destructor. Closes the archive.

Definition at line 211 of file StructuredArchive.h.

FStructuredArchive() [2/2]

FStructuredArchive::FStructuredArchive ( const FStructuredArchive & )

delete

Member Function Documentation

Close()

FORCEINLINE void FStructuredArchive::Close

(

)

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

Definition at line 220 of file StructuredArchive.h.

GetArchiveState()

FORCEINLINE const FArchiveState & FStructuredArchive::GetArchiveState ( ) const

inline

Gets the archiving state.

Definition at line 98 of file StructuredArchive.h.

Here is the call graph for this function:

GetUnderlyingArchive()

FORCEINLINE FArchive & FStructuredArchive::GetUnderlyingArchive ( ) const

inline

Gets the serialization context from the underlying archive.

Definition at line 90 of file StructuredArchive.h.

Here is the caller graph for this function:

Open()

FORCEINLINE FStructuredArchiveSlot FStructuredArchive::Open

(

)

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

Definition at line 215 of file StructuredArchive.h.

operator=()

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

delete

Friends And Related Symbol Documentation

FStructuredArchiveChildReader

friend class FStructuredArchiveChildReader

friend

Definition at line 107 of file StructuredArchive.h.

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

Member Data Documentation

Formatter

FArchiveFormatterType& FStructuredArchive::Formatter

private

Reference to the formatter that actually writes out the data to the underlying archive

Definition at line 114 of file StructuredArchive.h.

FStructuredArchiveArray

friend FStructuredArchive::FStructuredArchiveArray

private

Definition at line 54 of file StructuredArchive.h.

FStructuredArchiveMap

friend FStructuredArchive::FStructuredArchiveMap

private

Definition at line 56 of file StructuredArchive.h.

FStructuredArchiveRecord

friend FStructuredArchive::FStructuredArchiveRecord

private

Definition at line 53 of file StructuredArchive.h.

FStructuredArchiveSlot

friend FStructuredArchive::FStructuredArchiveSlot

private

Definition at line 52 of file StructuredArchive.h.

FStructuredArchiveStream

friend FStructuredArchive::FStructuredArchiveStream

private

Definition at line 55 of file StructuredArchive.h.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Serialization/StructuredArchive.h