IStructSerializerBackend Class Reference

#include <IStructSerializerBackend.h>

Inheritance diagram for IStructSerializerBackend:

Public Member Functions
virtual void	BeginArray (const FStructSerializerState &State)=0
virtual void	BeginStructure (const FStructSerializerState &State)=0
virtual void	EndArray (const FStructSerializerState &State)=0
virtual void	EndStructure (const FStructSerializerState &State)=0
virtual void	WriteComment (const FString &Comment)=0
virtual void	WriteProperty (const FStructSerializerState &State, int32 ArrayIndex=0)=0
virtual bool	WritePODArray (const FStructSerializerState &State)
virtual	~IStructSerializerBackend ()

Detailed Description

Interface for UStruct serializer backends.

Constructor & Destructor Documentation

~IStructSerializerBackend()

virtual IStructSerializerBackend::~IStructSerializerBackend ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

BeginArray()

virtual void IStructSerializerBackend::BeginArray ( const FStructSerializerState &  State )

pure virtual

Signals the beginning of an array.

State.ValueProperty points to the property that holds the array.

Parameters

State

The serializer's current state.

See also

BeginStructure, EndArray

Implemented in FCborStructSerializerBackend, and FJsonStructSerializerBackend.

BeginStructure()

virtual void IStructSerializerBackend::BeginStructure ( const FStructSerializerState &  State )

pure virtual

Signals the beginning of a child structure.

State.ValueProperty points to the property that holds the struct.

Parameters

State

The serializer's current state.

See also

BeginArray, EndStructure

Implemented in FCborStructSerializerBackend, and FJsonStructSerializerBackend.

EndArray()

virtual void IStructSerializerBackend::EndArray ( const FStructSerializerState &  State )

pure virtual

Signals the end of an array.

State.ValueProperty points to the property that holds the array.

Parameters

State

The serializer's current state.

See also

BeginArray, EndStructure

Implemented in FCborStructSerializerBackend, and FJsonStructSerializerBackend.

EndStructure()

virtual void IStructSerializerBackend::EndStructure ( const FStructSerializerState &  State )

pure virtual

Signals the end of an object.

State.ValueProperty points to the property that holds the struct.

Parameters

State

The serializer's current state.

See also

BeginStructure, EndArray

Implemented in FCborStructSerializerBackend, and FJsonStructSerializerBackend.

WriteComment()

virtual void IStructSerializerBackend::WriteComment ( const FString &  Comment )

pure virtual

Writes a comment to the output stream.

Parameters

Comment

The comment text.

See also

BeginArray, BeginStructure, EndArray, EndStructure, WriteProperty

Implemented in FCborStructSerializerBackend, and FJsonStructSerializerBackend.

WritePODArray()

virtual bool IStructSerializerBackend::WritePODArray ( const FStructSerializerState &  State )

inlinevirtual

Writes a POD Array property to the output stream.

Note

implementations will support only a Int8 or Byte array at the moment

State.ValueProperty points to the property that holds the value to write. needs to be an ArrayProperty with a properly supported InnerProperty. State.ValueData points to the actual data to write. The array itself in this case State.TypeInfo contains the data's type information

Parameters

State

The serializer's current state.

Returns

true if the array was properly written entirely as a pod array, false is we need to fallback to per element serialization

See also

BeginArray, BeginStructure, EndArray, EndStructure, WriteComment

Reimplemented in FCborStructSerializerBackend, and FJsonStructSerializerBackend.

WriteProperty()

virtual void IStructSerializerBackend::WriteProperty ( const FStructSerializerState &  State, int32  ArrayIndex = 0  )

pure virtual

Writes a property to the output stream.

Depending on the context, properties to be written can be either object properties or array elements.

State.KeyProperty points to the key property that holds the data to write. State.KeyData points to the key property's data. State.ValueProperty points to the property that holds the value to write. State.ValueData points to the actual data to write. State.TypeInfo contains the data's type information State.ArrayIndex is the optional index if the data is a value in an array.

Parameters

State

The serializer's current state.

See also

BeginArray, BeginStructure, EndArray, EndStructure, WriteComment

Implemented in FCborStructSerializerBackend, FJsonStructSerializerBackend, and FNativeJSStructSerializerBackend.

---

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

• Engine/Source/Runtime/Serialization/Public/IStructSerializerBackend.h