UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FJsonSerializerReader Class Reference

#include <JsonSerializerReader.h>

+ Inheritance diagram for FJsonSerializerReader:

Public Member Functions

JSON_API FJsonSerializerReader (TSharedPtr< FJsonObject > InJsonObject)
 
virtual JSON_API ~FJsonSerializerReader ()
 
virtual JSON_API bool IsLoading () const override
 
virtual JSON_API bool IsSaving () const override
 
virtual JSON_API TSharedPtr< FJsonObjectGetObject () override
 
virtual JSON_API void StartObject () override
 
virtual JSON_API void StartObject (FStringView Name) override
 
virtual JSON_API void EndObject () override
 
virtual JSON_API void StartArray () override
 
virtual JSON_API void StartArray (FStringView Name) override
 
virtual JSON_API void EndArray () override
 
virtual JSON_API void Serialize (FStringView Name, int32 &Value) override
 
virtual JSON_API void Serialize (FStringView Name, uint32 &Value) override
 
virtual JSON_API void Serialize (FStringView Name, int64 &Value) override
 
virtual JSON_API void Serialize (FStringView Name, bool &Value) override
 
virtual JSON_API void Serialize (FStringView Name, FString &Value) override
 
virtual JSON_API void Serialize (FStringView Name, FUtf8String &Value) override
 
virtual JSON_API void Serialize (FStringView Name, FText &Value) override
 
virtual JSON_API void Serialize (FStringView Name, float &Value) override
 
virtual JSON_API void Serialize (FStringView Name, double &Value) override
 
virtual JSON_API void Serialize (FStringView Name, FDateTime &Value) override
 
virtual JSON_API void Serialize (FStringView Name, JsonSimpleValueVariant &InVariant) override
 
virtual JSON_API void SerializeArray (FJsonSerializableArray &Array) override
 
virtual JSON_API void SerializeArray (FStringView Name, FJsonSerializableArray &Array) override
 
virtual JSON_API void SerializeArray (FStringView Name, FJsonSerializableArrayInt &Array) override
 
virtual JSON_API void SerializeArray (FStringView Name, FJsonSerializableArrayFloat &Array) override
 
virtual JSON_API void SerializeMap (FStringView Name, FJsonSerializableKeyValueMap &Map) override
 
virtual JSON_API void SerializeMap (FStringView Name, FJsonSerializableKeyValueMapInt &Map) override
 
virtual JSON_API void SerializeMap (FStringView Name, FJsonSerializableKeyValueMapArrayInt &Map) override
 
virtual JSON_API void SerializeMap (FStringView Name, FJsonSerializableKeyValueMapInt64 &Map) override
 
virtual JSON_API void SerializeMap (FStringView Name, FJsonSerializableKeyValueMapFloat &Map) override
 
virtual JSON_API void SerializeMap (FStringView Name, FJsonSerializableKeySimpleValueVariantMap &Map) override
 
virtual JSON_API void SerializeSimpleMap (FJsonSerializableKeyValueMap &Map) override
 
virtual JSON_API void SerializeMapSafe (FStringView Name, FJsonSerializableKeyValueMap &Map) override
 
virtual JSON_API void WriteIdentifierPrefix (FStringView Name) override
 
virtual JSON_API void WriteRawJSONValue (FStringView Value) override
 
virtual JSON_API void WriteRawJSONValue (FUtf8StringView Value) override
 
- Public Member Functions inherited from FJsonSerializerBase
void StartObject (FAnsiStringView Name)
 
void StartArray (FAnsiStringView Name)
 

Detailed Description

Implements the abstract serializer interface hiding the underlying reader object

Constructor & Destructor Documentation

◆ FJsonSerializerReader()

FJsonSerializerReader::FJsonSerializerReader ( TSharedPtr< FJsonObject InJsonObject)

Inits the base JSON object that is being read from

Parameters
InJsonObjectthe JSON object to serialize from

◆ ~FJsonSerializerReader()

FJsonSerializerReader::~FJsonSerializerReader ( )
virtual

Member Function Documentation

◆ EndArray()

void FJsonSerializerReader::EndArray ( )
overridevirtual

Ignored

Implements FJsonSerializerBase.

◆ EndObject()

void FJsonSerializerReader::EndObject ( )
overridevirtual

Ignored

Implements FJsonSerializerBase.

◆ GetObject()

TSharedPtr< FJsonObject > FJsonSerializerReader::GetObject ( )
overridevirtual

Access to the root Json object being read

Implements FJsonSerializerBase.

◆ IsLoading()

bool FJsonSerializerReader::IsLoading ( ) const
overridevirtual

Is the JSON being read from

Implements FJsonSerializerBase.

◆ IsSaving()

bool FJsonSerializerReader::IsSaving ( ) const
overridevirtual

Is the JSON being written to

Implements FJsonSerializerBase.

◆ Serialize() [1/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
bool Value 
)
overridevirtual

If the underlying json object has the field, it is read into the value

Parameters
Namethe name of the field to read
Valuethe out value to read the data into

Implements FJsonSerializerBase.

◆ Serialize() [2/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
double Value 
)
overridevirtual

If the underlying json object has the field, it is read into the value

Parameters
Namethe name of the field to read
Valuethe out value to read the data into

Implements FJsonSerializerBase.

◆ Serialize() [3/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
FDateTime Value 
)
overridevirtual

Writes the field name and the corresponding value to the JSON data

Parameters
Namethe field name to write out
Valuethe value to write out

Implements FJsonSerializerBase.

◆ Serialize() [4/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
float Value 
)
overridevirtual

If the underlying json object has the field, it is read into the value

Parameters
Namethe name of the field to read
Valuethe out value to read the data into

Implements FJsonSerializerBase.

◆ Serialize() [5/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
FString &  Value 
)
overridevirtual

If the underlying json object has the field, it is read into the value

Parameters
Namethe name of the field to read
Valuethe out value to read the data into

Implements FJsonSerializerBase.

◆ Serialize() [6/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
FText Value 
)
overridevirtual

If the underlying json object has the field, it is read into the value

Parameters
Namethe name of the field to read
Valuethe out value to read the data into

Implements FJsonSerializerBase.

◆ Serialize() [7/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
FUtf8String Value 
)
overridevirtual

If the underlying json object has the field, it is read into the value

Parameters
Namethe name of the field to read
Valuethe out value to read the data into

Implements FJsonSerializerBase.

◆ Serialize() [8/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
int32 Value 
)
overridevirtual

If the underlying json object has the field, it is read into the value

Parameters
Namethe name of the field to read
Valuethe out value to read the data into

Implements FJsonSerializerBase.

◆ Serialize() [9/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
int64 Value 
)
overridevirtual

If the underlying json object has the field, it is read into the value

Parameters
Namethe name of the field to read
Valuethe out value to read the data into

Implements FJsonSerializerBase.

◆ Serialize() [10/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
JsonSimpleValueVariant InVariant 
)
overridevirtual

Writes the field name and the corresponding value to the JSON data

Parameters
Namethe field name to write out
Valuethe value to write out

Implements FJsonSerializerBase.

◆ Serialize() [11/11]

void FJsonSerializerReader::Serialize ( FStringView  Name,
uint32 Value 
)
overridevirtual

If the underlying json object has the field, it is read into the value

Parameters
Namethe name of the field to read
Valuethe out value to read the data into

Implements FJsonSerializerBase.

◆ SerializeArray() [1/4]

void FJsonSerializerReader::SerializeArray ( FJsonSerializableArray Array)
overridevirtual

Serializes an array of values

Parameters
Namethe name of the property to serialize
Arraythe array to serialize

Implements FJsonSerializerBase.

◆ SerializeArray() [2/4]

void FJsonSerializerReader::SerializeArray ( FStringView  Name,
FJsonSerializableArray Array 
)
overridevirtual

Serializes an array of values with an identifier

Parameters
Namethe name of the property to serialize
Arraythe array to serialize

Implements FJsonSerializerBase.

◆ SerializeArray() [3/4]

void FJsonSerializerReader::SerializeArray ( FStringView  Name,
FJsonSerializableArrayFloat Array 
)
overridevirtual

Serializes an array of values with an identifier

Parameters
Namethe name of the property to serialize
Arraythe array to serialize

Implements FJsonSerializerBase.

◆ SerializeArray() [4/4]

void FJsonSerializerReader::SerializeArray ( FStringView  Name,
FJsonSerializableArrayInt Array 
)
overridevirtual

Serializes an array of values with an identifier

Parameters
Namethe name of the property to serialize
Arraythe array to serialize

Implements FJsonSerializerBase.

◆ SerializeMap() [1/6]

void FJsonSerializerReader::SerializeMap ( FStringView  Name,
FJsonSerializableKeySimpleValueVariantMap Map 
)
overridevirtual

Serializes the keys & values for map

Parameters
Namethe name of the property to serialize
Mapthe map to serialize

Implements FJsonSerializerBase.

◆ SerializeMap() [2/6]

void FJsonSerializerReader::SerializeMap ( FStringView  Name,
FJsonSerializableKeyValueMap Map 
)
overridevirtual

Serializes the keys & values for map

Parameters
Namethe name of the property to serialize
Mapthe map to serialize

Implements FJsonSerializerBase.

◆ SerializeMap() [3/6]

void FJsonSerializerReader::SerializeMap ( FStringView  Name,
FJsonSerializableKeyValueMapArrayInt Map 
)
overridevirtual

Serializes the keys & values for map

Parameters
Namethe name of the property to serialize
Mapthe map to serialize

Implements FJsonSerializerBase.

◆ SerializeMap() [4/6]

void FJsonSerializerReader::SerializeMap ( FStringView  Name,
FJsonSerializableKeyValueMapFloat Map 
)
overridevirtual

Serializes the keys & values for map

Parameters
Namethe name of the property to serialize
Mapthe map to serialize

Implements FJsonSerializerBase.

◆ SerializeMap() [5/6]

void FJsonSerializerReader::SerializeMap ( FStringView  Name,
FJsonSerializableKeyValueMapInt Map 
)
overridevirtual

Serializes the keys & values for map

Parameters
Namethe name of the property to serialize
Mapthe map to serialize

Implements FJsonSerializerBase.

◆ SerializeMap() [6/6]

void FJsonSerializerReader::SerializeMap ( FStringView  Name,
FJsonSerializableKeyValueMapInt64 Map 
)
overridevirtual

Serializes the keys & values for map

Parameters
Namethe name of the property to serialize
Mapthe map to serialize

Implements FJsonSerializerBase.

◆ SerializeMapSafe()

void FJsonSerializerReader::SerializeMapSafe ( FStringView  Name,
FJsonSerializableKeyValueMap Map 
)
overridevirtual

Deserializes keys and values from an object into a map, but only if the value is trivially convertable to string.

Parameters
NameName of property to deserialize
MapThe Map to fill with String values found

Implements FJsonSerializerBase.

◆ SerializeSimpleMap()

void FJsonSerializerReader::SerializeSimpleMap ( FJsonSerializableKeyValueMap Map)
overridevirtual

Implements FJsonSerializerBase.

◆ StartArray() [1/2]

void FJsonSerializerReader::StartArray ( )
overridevirtual

Ignored

Implements FJsonSerializerBase.

◆ StartArray() [2/2]

void FJsonSerializerReader::StartArray ( FStringView  Name)
overridevirtual

Ignored

Implements FJsonSerializerBase.

◆ StartObject() [1/2]

void FJsonSerializerReader::StartObject ( )
overridevirtual

Ignored

Implements FJsonSerializerBase.

◆ StartObject() [2/2]

void FJsonSerializerReader::StartObject ( FStringView  Name)
overridevirtual

Ignored

Implements FJsonSerializerBase.

◆ WriteIdentifierPrefix()

void FJsonSerializerReader::WriteIdentifierPrefix ( FStringView  Name)
overridevirtual

Implements FJsonSerializerBase.

◆ WriteRawJSONValue() [1/2]

void FJsonSerializerReader::WriteRawJSONValue ( FStringView  Value)
overridevirtual

Implements FJsonSerializerBase.

◆ WriteRawJSONValue() [2/2]

void FJsonSerializerReader::WriteRawJSONValue ( FUtf8StringView  Value)
overridevirtual

Implements FJsonSerializerBase.


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