FCborStructDeserializerBackend Class Reference

#include <CborStructDeserializerBackend.h>

Inheritance diagram for FCborStructDeserializerBackend:

Public Member Functions
SERIALIZATION_API	FCborStructDeserializerBackend (FArchive &Archive, ECborEndianness CborDataEndianness=ECborEndianness::Platform, bool bInIsLWCCompatibilityMode=false)
virtual SERIALIZATION_API	~FCborStructDeserializerBackend ()
virtual SERIALIZATION_API const FString &	GetCurrentPropertyName () const override
virtual SERIALIZATION_API FString	GetDebugString () const override
virtual SERIALIZATION_API const FString &	GetLastErrorMessage () const override
virtual SERIALIZATION_API bool	GetNextToken (EStructDeserializerBackendTokens &OutToken) override
virtual SERIALIZATION_API bool	ReadProperty (FProperty *Property, FProperty *Outer, void *Data, int32 ArrayIndex) override
virtual SERIALIZATION_API bool	ReadPODArray (FArrayProperty *ArrayProperty, void *Data) override
virtual SERIALIZATION_API void	SkipArray () override
virtual SERIALIZATION_API void	SkipStructure () override
Public Member Functions inherited from IStructDeserializerBackend
virtual	~IStructDeserializerBackend ()

Detailed Description

Implements a reader for UStruct deserialization using Cbor.

Constructor & Destructor Documentation

FCborStructDeserializerBackend()

FCborStructDeserializerBackend::FCborStructDeserializerBackend	(	FArchive &	Archive,
		ECborEndianness	CborDataEndianness = ECborEndianness::Platform,
		bool	bInIsLWCCompatibilityMode = false
	)

Creates and initializes a new instance.

Parameters

Archive	The archive to deserialize from.
CborDataEndianness	The CBOR data endianness stored in the archive.

Note

For backward compatibility and performance, the implementation default to the the platform endianness rather than the CBOR standard one (big endian).

~FCborStructDeserializerBackend()

FCborStructDeserializerBackend::~FCborStructDeserializerBackend ( )

virtualdefault

Member Function Documentation

GetCurrentPropertyName()

const FString & FCborStructDeserializerBackend::GetCurrentPropertyName ( ) const

overridevirtual

Gets the identifier of the current field.

Returns

The field's name.

Implements IStructDeserializerBackend.

GetDebugString()

FString FCborStructDeserializerBackend::GetDebugString ( ) const

overridevirtual

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.

Implements IStructDeserializerBackend.

GetLastErrorMessage()

const FString & FCborStructDeserializerBackend::GetLastErrorMessage ( ) const

overridevirtual

Gets the last error message.

Returns

Error message.

Implements IStructDeserializerBackend.

GetNextToken()

bool FCborStructDeserializerBackend::GetNextToken ( EStructDeserializerBackendTokens &  OutToken )

overridevirtual

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.

Implements IStructDeserializerBackend.

ReadPODArray()

bool FCborStructDeserializerBackend::ReadPODArray ( FArrayProperty *  ArrayProperty, void *  Data  )

overridevirtual

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 from IStructDeserializerBackend.

ReadProperty()

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

overridevirtual

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.

Implements IStructDeserializerBackend.

SkipArray()

void FCborStructDeserializerBackend::SkipArray ( )

overridevirtual

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

Implements IStructDeserializerBackend.

SkipStructure()

void FCborStructDeserializerBackend::SkipStructure ( )

overridevirtual

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

Implements IStructDeserializerBackend.

---

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

• Engine/Source/Runtime/Serialization/Public/Backends/CborStructDeserializerBackend.h
• Engine/Source/Runtime/Serialization/Private/Backends/CborStructDeserializerBackend.cpp