Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::JsonSerializationResult::ResultCode Union Reference

#include <JsonSerializationResult.h>

Public Member Functions

 ResultCode (Tasks task)
 
 ResultCode (Tasks task, Outcomes result)
 
bool HasDoneWork () const
 
ResultCodeCombine (ResultCode other)
 
ResultCodeCombine (const Result &other)
 
Tasks GetTask () const
 
Processing GetProcessing () const
 
Outcomes GetOutcome () const
 
void AppendToString (AZ::OSString &output, AZStd::string_view path) const
 
void AppendToString (AZStd::string &output, AZStd::string_view path) const
 
AZStd::string ToString (AZStd::string_view path) const
 
AZ::OSString ToOSString (AZStd::string_view path) const
 

Static Public Member Functions

static ResultCode Combine (ResultCode lhs, ResultCode rhs)
 

Detailed Description

A lightweight result returned by all major functions in the Json Serialization. This is essentially a 32 bit integer but with additional functionality to be more descriptive than a standard integer result code.

Member Function Documentation

◆ AppendToString() [1/2]

void AZ::JsonSerializationResult::ResultCode::AppendToString ( AZ::OSString output,
AZStd::string_view  path 
) const

Append the provided string with a description of the result code. @output The string to append to. @path Path to the value/field/type that resulted in this result code.

◆ AppendToString() [2/2]

void AZ::JsonSerializationResult::ResultCode::AppendToString ( AZStd::string output,
AZStd::string_view  path 
) const

Append the provided string with a description of the result code. @output The string to append to. @path Path to the value/field/type that resulted in this result code.

◆ ToOSString()

AZ::OSString AZ::JsonSerializationResult::ResultCode::ToOSString ( AZStd::string_view  path) const

Creates a string with the description of the results code. @path Path to the value/field/type that resulted in this result code.

◆ ToString()

AZStd::string AZ::JsonSerializationResult::ResultCode::ToString ( AZStd::string_view  path) const

Creates a string with the description of the results code. @path Path to the value/field/type that resulted in this result code.


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