1. Epic GamesDeveloper
  3. Serialize

Serialize

Function Overloads

API > API/Runtime > API/Runtime/Json > API/Runtime/Json/FJsonSerializer

Overloads

Name Remarks Include Path Unreal Specifiers

static bool Serialize ( const TArray< TSharedPtr< FJsonValue > >& Array,
const TSharedRef< TJsonWriter< CharType, PrintPolicy > >& Writer,
bool bCloseWriter
)

 Serialize the passed array of json values into the writer. Serialization/JsonSerializer.h  

static bool Serialize ( const TArray< TSharedPtr< FJsonValue > >& Array,
TJsonWriter< CharType, PrintPolicy >& Writer,
bool bCloseWriter
)

 Serialize the passed array of json values into the writer. Serialization/JsonSerializer.h  

static bool Serialize ( const TSharedRef< FJsonObject >& Object,
const TSharedRef< TJsonWriter< CharType, PrintPolicy > >& Writer,
bool bCloseWriter
)

 Serialize the passed Json object into the writer. Serialization/JsonSerializer.h  

static bool Serialize ( const TSharedRef< FJsonObject >& Object,
TJsonWriter< CharType, PrintPolicy >& Writer,
bool bCloseWriter
)

 Serialize the passed Json object into the writer. Serialization/JsonSerializer.h  

static bool Serialize ( const TSharedRef< FElement >& StartingElement,
TJsonWriter< CharType, PrintPolicy >& Writer,
bool bCloseWriter
)

   Serialization/JsonSerializer.h  

static bool Serialize ( const TSharedPtr< FJsonValue >& Value,
const FString& Identifier,
const TSharedRef< TJsonWriter< CharType, PrintPolicy > >& Writer,
bool bCloseWriter
)

 Serialize the passed Json value and identifier into the writer. Serialization/JsonSerializer.h  

static bool Serialize ( const TSharedPtr< FJsonValue >& Value,
const FString& Identifier,
TJsonWriter< CharType, PrintPolicy >& Writer,
bool bCloseWriter
)

 Serialize the passed Json value and identifier into the writer. Serialization/JsonSerializer.h  

Serialize(const TArray< TSharedPtr< FJsonValue > > &, const TSharedRef< TJsonWriter< CharType, PrintPolicy > > &, bool)

Description

Serialize the passed array of json values into the writer. This will effectively serialize all of the values enclosed in [] square brackets. Example:

  • Writer state: [123 Parameter: Array: ["foo", "bar", "", 456] Serialization result: [123, ["foo", "bar", "", 456]
   
Name Serialize
Type function
Header File /Engine/Source/Runtime/Json/Public/Serialization/JsonSerializer.h
Include Path #include "Serialization/JsonSerializer.h" 
template<class CharType, class PrintPolicy>  
static bool Serialize  
(  
    const TArray < TSharedPtr < FJsonValue > > & Array,  
    const TSharedRef < TJsonWriter < CharType, PrintPolicy > > & Writer,  
    bool bCloseWriter  
)

Returns true if the serialization was successful, false otherwise.

Parameters

Name Remarks
Array The json array we are serializing
Writer The writer the array is written into.
bCloseWriter When set to true the Writer will be closed after the serialization.

Serialize(const TArray< TSharedPtr< FJsonValue > > &, TJsonWriter< CharType, PrintPolicy > &, bool)

Description

Serialize the passed array of json values into the writer. This will effectively serialize all of the values enclosed in [] square brackets. Example:

  • Writer state: [123 Parameter: Array: ["foo", "bar", "", 456] Serialization result: [123, ["foo", "bar", "", 456]
   
Name Serialize
Type function
Header File /Engine/Source/Runtime/Json/Public/Serialization/JsonSerializer.h
Include Path #include "Serialization/JsonSerializer.h" 
template<class CharType, class PrintPolicy>  
static bool Serialize  
(  
    const TArray < TSharedPtr < FJsonValue > > & Array,  
    TJsonWriter < CharType, PrintPolicy > & Writer,  
    bool bCloseWriter  
)

Returns true if the serialization was successful, false otherwise.

Parameters

Name Remarks
Array The json array we are serializing
Writer The writer the array is written into.
bCloseWriter When set to true the Writer will be closed after the serialization.

Serialize(const TSharedRef< FJsonObject > &, const TSharedRef< TJsonWriter< CharType, PrintPolicy > > &, bool)

Description

Serialize the passed Json object into the writer. This will effectively serialize all of the identifier:value pairs of the object enclosed in {} curly brackets. Example:

  • Writer state: [123 Parameter: Object: {"foo": "bar", "baz": "", "": 456} Serialization result: [123, {"foo": "bar", "baz": "", "": 456}
   
Name Serialize
Type function
Header File /Engine/Source/Runtime/Json/Public/Serialization/JsonSerializer.h
Include Path #include "Serialization/JsonSerializer.h" 
template<class CharType, class PrintPolicy>  
static bool Serialize  
(  
    const TSharedRef < FJsonObject > & Object,  
    const TSharedRef < TJsonWriter < CharType, PrintPolicy > > & Writer,  
    bool bCloseWriter  
)

Returns true if the serialization was successful, false otherwise.

Parameters

Name Remarks
Object The json object we are serializing
Writer The writer the object is written into.
bCloseWriter When set to true the Writer will be closed after the serialization.

Serialize(const TSharedRef< FJsonObject > &, TJsonWriter< CharType, PrintPolicy > &, bool)

Description

Serialize the passed Json object into the writer. This will effectively serialize all of the identifier:value pairs of the object enclosed in {} brackets. Example:

  • Writer state: [123 Parameter: Object: {"foo": "bar", "baz": "", "": 456} Serialization result: [123, {"foo": "bar", "baz": "", "": 456}
   
Name Serialize
Type function
Header File /Engine/Source/Runtime/Json/Public/Serialization/JsonSerializer.h
Include Path #include "Serialization/JsonSerializer.h" 
template<class CharType, class PrintPolicy>  
static bool Serialize  
(  
    const TSharedRef < FJsonObject > & Object,  
    TJsonWriter < CharType, PrintPolicy > & Writer,  
    bool bCloseWriter  
)

Returns true if the serialization was successful, false otherwise.

Parameters

Name Remarks
Object The json object we are serializing
Writer The writer the object is written into.
bCloseWriter When set to true the Writer will be closed after the serialization.

Serialize(const TSharedRef< FElement > &, TJsonWriter< CharType, PrintPolicy > &, bool)

   
Name Serialize
Type function
Header File /Engine/Source/Runtime/Json/Public/Serialization/JsonSerializer.h
Include Path #include "Serialization/JsonSerializer.h" 
template<class CharType, class PrintPolicy>  
static bool Serialize  
(  
    const TSharedRef < FElement > & StartingElement,  
    TJsonWriter < CharType, PrintPolicy > & Writer,  
    bool bCloseWriter  
)

Serialize(const TSharedPtr< FJsonValue > &, const FString &, const TSharedRef< TJsonWriter< CharType, PrintPolicy > > &, bool)

Description

Serialize the passed Json value and identifier into the writer. Empty string identifiers will be ignored when the writer is not writing inside of a json object and only the value will be serialized. If the writer is in a state where it's currently writing inside of a json object, then the identifier will always be serialized. Examples:

  • Writer state: { "foo": "bar" Parameters: Identifier: "" Value: "baz" Serialization result: { "foo": "bar", "": "baz" //empty identifier is serialized as a valid key for the key:value pair "":"baz"

Writer state: { "foo": ["bar" Parameters: Identifier: "" Value: "baz" Serialization result: { foo: ["bar", "baz" //empty identifier is ignored since we are writing into an array and not an object.

   
Name Serialize
Type function
Header File /Engine/Source/Runtime/Json/Public/Serialization/JsonSerializer.h
Include Path #include "Serialization/JsonSerializer.h" 
template<class CharType, class PrintPolicy>  
static bool Serialize  
(  
    const TSharedPtr < FJsonValue > & Value,  
    const FString & Identifier,  
    const TSharedRef < TJsonWriter < CharType, PrintPolicy > > & Writer,  
    bool bCloseWriter  
)

Returns true if the serialization was successful, false otherwise.

Parameters

Name Remarks
Value The json value we are serializing
Identifier The identifier of the value, empty identifiers are ignored outside of json objects.
Writer The writer the value and identifier are written into.
bCloseWriter When set to true the Writer will be closed after the serialization.

Serialize(const TSharedPtr< FJsonValue > &, const FString &, TJsonWriter< CharType, PrintPolicy > &, bool)

Description

Serialize the passed Json value and identifier into the writer. Empty string identifiers will be ignored when the writer is not writing inside of a json object and only the value will be serialized. If the writer is in a state where it's currently writing inside of a json object, then the identifier will always be serialized. Examples:

  • Writer state: { "foo": "bar" Parameters: Identifier: "" Value: "baz" Serialization result: { "foo": "bar", "": "baz" //empty identifier is serialized as a valid key for the key:value pair "":"baz"

Writer state: { "foo": ["bar" Parameters: Identifier: "" Value: "baz" Serialization result: { foo: ["bar", "baz" //empty identifier is ignored since we are writing into an array and not an object.

   
Name Serialize
Type function
Header File /Engine/Source/Runtime/Json/Public/Serialization/JsonSerializer.h
Include Path #include "Serialization/JsonSerializer.h" 
template<class CharType, class PrintPolicy>  
static bool Serialize  
(  
    const TSharedPtr < FJsonValue > & Value,  
    const FString & Identifier,  
    TJsonWriter < CharType, PrintPolicy > & Writer,  
    bool bCloseWriter  
)

Returns true if the serialization was successful, false otherwise.

Parameters

Name Remarks
Value The json value we are serializing
Identifier The identifier of the value, empty identifiers are ignored outside of json objects.
Writer The writer the value and identifier are written into.
bCloseWriter When set to true the Writer will be closed after the serialization.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page