IStructDeserializerBackend Class Reference

#include <IStructDeserializerBackend.h>

Inheritance diagram for IStructDeserializerBackend:

Public Member Functions
virtual const FString &	GetCurrentPropertyName () const =0
virtual FString	GetDebugString () const =0
virtual const FString &	GetLastErrorMessage () const =0
virtual bool	GetNextToken (EStructDeserializerBackendTokens &OutToken)=0
virtual bool	ReadProperty (FProperty *Property, FProperty *Outer, void *Data, int32 ArrayIndex)=0
virtual bool	ReadPODArray (FArrayProperty *ArrayProperty, void *Data)
virtual void	SkipArray ()=0
virtual void	SkipStructure ()=0
virtual	~IStructDeserializerBackend ()

Detailed Description

Interface for UStruct serializer backends.

Constructor & Destructor Documentation

~IStructDeserializerBackend()

virtual IStructDeserializerBackend::~IStructDeserializerBackend ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

GetCurrentPropertyName()

virtual const FString & IStructDeserializerBackend::GetCurrentPropertyName ( ) const

pure virtual

Gets the identifier of the current field.

Returns

The field's name.

Implemented in FCborStructDeserializerBackend, and FJsonStructDeserializerBackend.

GetDebugString()

virtual FString IStructDeserializerBackend::GetDebugString ( ) const

pure virtual

Gets a debug string for the reader's current state.

The returned string contains debug information that is relevant to the reader's serialization format. For example, it could be a line and column number for text based formats, or a byte offset for binary serialization formats.

Returns

The debug string.

Implemented in FCborStructDeserializerBackend, and FJsonStructDeserializerBackend.

GetLastErrorMessage()

virtual const FString & IStructDeserializerBackend::GetLastErrorMessage ( ) const

pure virtual

Gets the last error message.

Returns

Error message.

Implemented in FCborStructDeserializerBackend, and FJsonStructDeserializerBackend.

GetNextToken()

virtual bool IStructDeserializerBackend::GetNextToken ( EStructDeserializerBackendTokens &  OutToken )

pure virtual

Reads the next token from the stream.

Parameters

OutToken

Will contain the read token, if any.

Returns

true if a token was read, false otherwise.

Implemented in FCborStructDeserializerBackend, and FJsonStructDeserializerBackend.

ReadPODArray()

virtual bool IStructDeserializerBackend::ReadPODArray ( FArrayProperty *  ArrayProperty, void *  Data  )

inlinevirtual

Reads the specified POD Array property from the stream.

Note

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

Parameters

ArrayProperty	The array property to read into.
Data	The location of array to read the data into.

Returns

true on success, false if need to fall back to per element array serialization.

Reimplemented in FCborStructDeserializerBackend.

ReadProperty()

virtual bool IStructDeserializerBackend::ReadProperty ( FProperty *  Property, FProperty *  Outer, void *  Data, int32  ArrayIndex  )

pure virtual

Reads the specified property from the stream.

Parameters

Property	The property to read into.
Outer	The outer property holding the property to read (in case of arrays).
Data	The buffer that will hold the read data.
ArrayIndex	An index into the property array (for static arrays).

Returns

true on success, false otherwise.

Implemented in FCborStructDeserializerBackend, FJsonStructDeserializerBackend, and FNativeJSStructDeserializerBackend.

SkipArray()

virtual void IStructDeserializerBackend::SkipArray ( )

pure virtual

Skips the array that is currently being read from the stream.

Implemented in FCborStructDeserializerBackend, and FJsonStructDeserializerBackend.

SkipStructure()

virtual void IStructDeserializerBackend::SkipStructure ( )

pure virtual

Skips the object that is currently being read from the stream.

Implemented in FCborStructDeserializerBackend, and FJsonStructDeserializerBackend.

---

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

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