UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FJsonSerializerWriter< CharType, PrintPolicy > Class Template Reference

#include <JsonSerializerWriter.h>

+ Inheritance diagram for FJsonSerializerWriter< CharType, PrintPolicy >:

Public Member Functions

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

Detailed Description

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
class FJsonSerializerWriter< CharType, PrintPolicy >

Implements the abstract serializer interface hiding the underlying writer object

Constructor & Destructor Documentation

◆ FJsonSerializerWriter()

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
FJsonSerializerWriter< CharType, PrintPolicy >::FJsonSerializerWriter ( TSharedRef< TJsonWriter< CharType, PrintPolicy > >  InJsonWriter)
inline

Initializes the writer object

Parameters
InJsonWriterthe object to write the JSON output to

◆ ~FJsonSerializerWriter()

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual FJsonSerializerWriter< CharType, PrintPolicy >::~FJsonSerializerWriter ( )
inlinevirtual

Member Function Documentation

◆ EndArray()

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::EndArray ( )
inlineoverridevirtual

Implements FJsonSerializerBase.

◆ EndObject()

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::EndObject ( )
inlineoverridevirtual

Completes the definition of an object "}"

Implements FJsonSerializerBase.

◆ GetObject()

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual TSharedPtr< FJsonObject > FJsonSerializerWriter< CharType, PrintPolicy >::GetObject ( )
inlineoverridevirtual

Access to the root object

Implements FJsonSerializerBase.

◆ IsLoading()

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual bool FJsonSerializerWriter< CharType, PrintPolicy >::IsLoading ( ) const
inlineoverridevirtual

Is the JSON being read from

Implements FJsonSerializerBase.

◆ IsSaving()

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual bool FJsonSerializerWriter< CharType, PrintPolicy >::IsSaving ( ) const
inlineoverridevirtual

Is the JSON being written to

Implements FJsonSerializerBase.

◆ Serialize() [1/11]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
bool Value 
)
inlineoverridevirtual

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() [2/11]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
double Value 
)
inlineoverridevirtual

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() [3/11]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
FDateTime Value 
)
inlineoverridevirtual

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]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
float Value 
)
inlineoverridevirtual

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() [5/11]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
FString &  Value 
)
inlineoverridevirtual

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() [6/11]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
FText Value 
)
inlineoverridevirtual

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() [7/11]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
FUtf8String Value 
)
inlineoverridevirtual

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() [8/11]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
int32 Value 
)
inlineoverridevirtual

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() [9/11]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
int64 Value 
)
inlineoverridevirtual

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() [10/11]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
JsonSimpleValueVariant InVariant 
)
inlineoverridevirtual

Implements FJsonSerializerBase.

◆ Serialize() [11/11]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::Serialize ( FStringView  Name,
uint32 Value 
)
inlineoverridevirtual

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.

◆ SerializeArray() [1/4]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeArray ( FJsonSerializableArray Array)
inlineoverridevirtual

Serializes an array of values

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

Implements FJsonSerializerBase.

◆ SerializeArray() [2/4]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeArray ( FStringView  Name,
FJsonSerializableArray Array 
)
inlineoverridevirtual

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]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeArray ( FStringView  Name,
FJsonSerializableArrayFloat Array 
)
inlineoverridevirtual

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]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeArray ( FStringView  Name,
FJsonSerializableArrayInt Array 
)
inlineoverridevirtual

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]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeMap ( FStringView  Name,
FJsonSerializableKeySimpleValueVariantMap Map 
)
inlineoverridevirtual

Implements FJsonSerializerBase.

◆ SerializeMap() [2/6]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeMap ( FStringView  Name,
FJsonSerializableKeyValueMap Map 
)
inlineoverridevirtual

Serializes the keys & values for map

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

Implements FJsonSerializerBase.

◆ SerializeMap() [3/6]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeMap ( FStringView  Name,
FJsonSerializableKeyValueMapArrayInt Map 
)
inlineoverridevirtual

Serializes the keys & values for map

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

Implements FJsonSerializerBase.

◆ SerializeMap() [4/6]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeMap ( FStringView  Name,
FJsonSerializableKeyValueMapFloat Map 
)
inlineoverridevirtual

Serializes the keys & values for map

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

Implements FJsonSerializerBase.

◆ SerializeMap() [5/6]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeMap ( FStringView  Name,
FJsonSerializableKeyValueMapInt Map 
)
inlineoverridevirtual

Serializes the keys & values for map

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

Implements FJsonSerializerBase.

◆ SerializeMap() [6/6]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeMap ( FStringView  Name,
FJsonSerializableKeyValueMapInt64 Map 
)
inlineoverridevirtual

Serializes the keys & values for map

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

Implements FJsonSerializerBase.

◆ SerializeMapSafe()

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeMapSafe ( FStringView  Name,
FJsonSerializableKeyValueMap Map 
)
inlinevirtual

Serializes keys and values from an object into a map.

Parameters
NameName of property to serialize
MapThe Map to copy String values from

Implements FJsonSerializerBase.

◆ SerializeSimpleMap()

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::SerializeSimpleMap ( FJsonSerializableKeyValueMap Map)
inlineoverridevirtual

Implements FJsonSerializerBase.

◆ StartArray() [1/2]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::StartArray ( )
inlineoverridevirtual

Implements FJsonSerializerBase.

◆ StartArray() [2/2]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::StartArray ( FStringView  Name)
inlineoverridevirtual

Implements FJsonSerializerBase.

◆ StartObject() [1/2]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::StartObject ( )
inlineoverridevirtual

Starts a new object "{"

Implements FJsonSerializerBase.

◆ StartObject() [2/2]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::StartObject ( FStringView  Name)
inlineoverridevirtual

Starts a new object "{"

Implements FJsonSerializerBase.

◆ WriteIdentifierPrefix()

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::WriteIdentifierPrefix ( FStringView  Name)
inlinevirtual

Implements FJsonSerializerBase.

◆ WriteRawJSONValue() [1/2]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::WriteRawJSONValue ( FStringView  Value)
inlinevirtual

Implements FJsonSerializerBase.

◆ WriteRawJSONValue() [2/2]

template<class CharType = TCHAR, class PrintPolicy = TPrettyJsonPrintPolicy<CharType>>
virtual void FJsonSerializerWriter< CharType, PrintPolicy >::WriteRawJSONValue ( FUtf8StringView  Value)
inlinevirtual

Implements FJsonSerializerBase.


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