UnifiedError.h File Reference

#include "CoreTypes.h"
#include "Containers/Utf8String.h"
#include "Containers/StringView.h"
#include "Internationalization/Internationalization.h"
#include "Internationalization/Text.h"
#include "Serialization/CompactBinaryWriter.h"
#include "Logging/StructuredLogFormat.h"
#include "Misc/TVariant.h"
#include "Templates/RefCounting.h"
#include <type_traits>

Go to the source code of this file.

Classes
struct	deferred_false< typename >
class	TErrorStructFeatures< T >
struct	TStringLiteralWithColonsReplaced< N >
struct	TStringLiteralWithSpacesReplaced< N >
class	UE::UnifiedError::IErrorDetails
class	UE::UnifiedError::FManditoryErrorDetails
	FManditoryErrorDetails every FError needs to be initialized with one of these, it contains core information about the error including errorcodestring and module name. More...
class	UE::UnifiedError::FErrorDetailsRegistry
class	UE::UnifiedError::FRefCountedErrorDetails
	FRefCountedErrorDetails; base implementation of refcounting for IErrorDetails, this is used for heap allocated IErrorDetails implementations. More...
class	UE::UnifiedError::FDynamicErrorDetails
	FDynamicErrorDetails; base implementation of inner error details, for use by derived classes to reduce unnessisary reimplementation. More...
class	UE::UnifiedError::TErrorDetails< T >
class	UE::UnifiedError::FError
class	UE::UnifiedError::FStaticErrorDetails
	FStaticErrorDetails; static error details and members are statically allocated Every error which uses DEFINE_ERROR will have FStaticErrorDetails generated for it Can not rely on it to be available for every error as some Error conversion functions will not use pregenerated errors or error codesF Use FError::GetErrorDetails to discover FStaticErrorDetails. More...

Namespaces
namespace	UE
namespace	UE::UnifiedError
namespace	UE::UnifiedError::ErrorRegistry

Macros
#define	UE_DECLARE_ERRORSTRUCT_FEATURES(DetailsNameSpace, DetailsStructName)
#define	UE_DECLARE_ERROR_DETAILS_INTERNAL(DetailsNamespace, TypeName)
#define	UE_DECLARE_FERROR_DETAILS_ABSTRACT(DetailsNamespace, TypeName)
#define	UE_DECLARE_FERROR_DETAILS(DetailsNamespace, TypeName)
#define	UE_DECLARE_ERROR_MODULE(DeclareApi, ModuleName)
#define	UE_DEFINE_ERROR_MODULE(ModuleName)
#define	UE_DECLARE_ERROR_INTERNAL(DeclareApi, ErrorName, ErrorCode, ModuleName, FormatString)
#define	UE_DEFINE_ERROR(ErrorName, ModuleName)
#define	UE_DECLARE_ERROR(DeclareApi, ErrorName, ErrorCode, ModuleName, FormatString)
#define	UE_DECLARE_ERROR_ONEPARAM(DeclareApi, ErrorName, ErrorCode, ModuleName, FormatString, ParamOneType, ParamOneName, ParamOneDefault)
#define	UE_DECLARE_ERROR_TWOPARAM(DeclareApi, ErrorName, ErrorCode, ModuleName, FormatString, ParamOneType, ParamOneName, ParamOneDefault, ParamTwoType, ParamTwoName, ParamTwoDefault)

Enumerations
enum class	UE::UnifiedError::EDetailFilter : uint8 {   UE::UnifiedError::IncludeInSerialize = 1 << 0 , UE::UnifiedError::IncludeInAnalytics = 1 << 1 , UE::UnifiedError::IncludeInContextLogMessage = 1 << 2 , UE::UnifiedError::IncludeInLogMessage = 1 << 3 ,   UE::UnifiedError::Default = IncludeInSerialize | IncludeInContextLogMessage , UE::UnifiedError::None = 0x00 , UE::UnifiedError::All = 0xff }

Functions
constexpr uint64	CompileTimeHashString (const char *String)
	UE::UnifiedError::ENUM_CLASS_FLAGS (EDetailFilter)
CORE_API uint32	UE::UnifiedError::ErrorRegistry::RegisterModule (const FAnsiStringView ModuleName)
CORE_API int32	UE::UnifiedError::ErrorRegistry::RegisterErrorCode (const FAnsiStringView ErrorName, int32 ModuleId, int32 ErrorCode)
CORE_API void	UE::UnifiedError::SerializeForLog (FCbWriter &Writer, const class FError &Error)
void	UE::UnifiedError::SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const FStringView &Value)
void	UE::UnifiedError::SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const FUtf8StringView &Value)
void	UE::UnifiedError::SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const int32 &Value)
void	UE::UnifiedError::SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const uint32 &Value)
void	UE::UnifiedError::SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const int64 &Value)
void	UE::UnifiedError::SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const uint64 &Value)
void	UE::UnifiedError::SerializeBasicToCb (FCbWriter &Writer, const FUtf8StringView &PropertyName, const FText &Value)
CORE_API FString	LexToString (const UE::UnifiedError::FError &Error)

Macro Definition Documentation

UE_DECLARE_ERROR

#define UE_DECLARE_ERROR	(		DeclareApi,
			ErrorName,
			ErrorCode,
			ModuleName,
			FormatString
	)

Value:

    UE_DECLARE_ERROR_INTERNAL(DeclareApi, ErrorName, ErrorCode, ModuleName, FormatString) \
    namespace UE::UnifiedError { namespace ModuleName { namespace ErrorName {\
            inline FError MakeError() { return FError(UE::UnifiedError::ModuleName::GetStaticModuleId(), GetErrorCodeId(), TRefCountPtr<const UE::UnifiedError::FManditoryErrorDetails>(GetStaticErrorDetails().GetReference())); } \
            template<typename ErrorContextType> \
            inline FError MakeError(ErrorContextType&& Ctx, EDetailFilter DetailFilter = EDetailFilter::Default) \
            {\
                FError Error(UE::UnifiedError::ModuleName::GetStaticModuleId(), GetErrorCodeId(), TRefCountPtr<const UE::UnifiedError::FManditoryErrorDetails>(GetStaticErrorDetails().GetReference())); \
                Error.PushErrorContext(MoveTemp(Ctx), DetailFilter); \
                return Error; \
            }\
    }}}

UE_DECLARE_ERROR_DETAILS_INTERNAL

#define UE_DECLARE_ERROR_DETAILS_INTERNAL	(		DetailsNamespace,
			TypeName
	)

Value:

    inline static constexpr FAnsiStringView StaticGetErrorDetailsTypeName() \
    {\
        return #DetailsNamespace"::"#TypeName;\
    }\
    virtual const FAnsiStringView GetErrorDetailsTypeName() const override \
    {\
        return StaticGetErrorDetailsTypeName();\
    }\
    inline static FAnsiStringView StaticGetErrorDetailsTypeNameForLog() \
    {\
        static auto Replaced = TStringLiteralWithColonsReplaced(#DetailsNamespace"_"#TypeName);\
        return Replaced.Str;\
    }\
    virtual const FAnsiStringView GetErrorDetailsTypeNameForLog() const override\
    {\
        return StaticGetErrorDetailsTypeNameForLog(); \
    }\
    virtual uint64 GetErrorDetailsTypeId() const \
    { \
        return StaticGetErrorDetailsTypeId(); \
    }\
    static uint64 StaticGetErrorDetailsTypeId() \
    { \
        return CompileTimeHashString(StaticGetErrorDetailsTypeName().GetData()); \
    }

UE_DECLARE_ERROR_INTERNAL

#define UE_DECLARE_ERROR_INTERNAL	(		DeclareApi,
			ErrorName,
			ErrorCode,
			ModuleName,
			FormatString
	)

Value:

    namespace UE::UnifiedError { namespace ModuleName { namespace ErrorName {\
            DeclareApi FAnsiStringView GetStaticErrorName(); \
            static constexpr int32 DeclaredErrorCode = ErrorCode; \
            extern DeclareApi const FText DeclaredFormatString; \
            DeclareApi int32 GetErrorCodeId(); \
            DeclareApi TRefCountPtr<const FStaticErrorDetails> GetStaticErrorDetails(); \
            DeclareApi const FError& GetStaticError(); \
            DeclareApi bool OfType(const FError& Other); \
            static inline FText GetFormatString() { return FormatString; } \
    }}}

UE_DECLARE_ERROR_MODULE

#define UE_DECLARE_ERROR_MODULE	(		DeclareApi,
			ModuleName
	)

Value:

    namespace UE::UnifiedError { namespace ModuleName {\
        DeclareApi FAnsiStringView GetStaticModuleName(); \
        DeclareApi int32 GetStaticModuleId(); \
    }}

UE_DECLARE_ERROR_ONEPARAM

#define UE_DECLARE_ERROR_ONEPARAM	(		DeclareApi,
			ErrorName,
			ErrorCode,
			ModuleName,
			FormatString,
			ParamOneType,
			ParamOneName,
			ParamOneDefault
	)

Value:

    UE_DECLARE_ERROR_INTERNAL(DeclareApi, ErrorName, ErrorCode, ModuleName, FText::FromString(UTF8TEXT("{"#ModuleName"_F"#ErrorName"}")) ) \
    namespace UE::UnifiedError { namespace ModuleName { \
            struct F##ErrorName \
            {\
                ParamOneType ParamOneName;\
            };\
    }}\
	UE_DECLARE_ERRORSTRUCT_FEATURES(ModuleName, F##ErrorName);\
    inline void SerializeForLog(FCbWriter& Writer, const UE::UnifiedError::ModuleName::F##ErrorName& Context)\
    {\
        Writer.BeginObject();\
        Writer.AddString(ANSITEXTVIEW("$type"), TErrorStructFeatures<UE::UnifiedError::ModuleName::F##ErrorName>::GetErrorContextTypeNameAsString());\
        UE::SerializeLogFormat(Writer, FormatString); \
        UE::UnifiedError::SerializeBasicToCb(Writer, ANSITEXTVIEW(#ParamOneName), Context.ParamOneName);\
        Writer.EndObject();\
    }\
    namespace UE::UnifiedError { namespace ModuleName { \
    namespace ErrorName { \
            inline FError MakeError(ParamOneType ParamOneName = ParamOneDefault) \
            { \
                FError Error = FError(UE::UnifiedError::ModuleName::GetStaticModuleId(), UE::UnifiedError::ModuleName::ErrorName::GetErrorCodeId(), UE::UnifiedError::ModuleName::ErrorName::GetStaticErrorDetails().GetReference()); \
                F##ErrorName Context = {ParamOneName}; \
                Error.PushErrorContext(MoveTemp(Context)); \
                return Error; \
            } \
    }}}

UE_DECLARE_ERROR_TWOPARAM

#define UE_DECLARE_ERROR_TWOPARAM	(		DeclareApi,
			ErrorName,
			ErrorCode,
			ModuleName,
			FormatString,
			ParamOneType,
			ParamOneName,
			ParamOneDefault,
			ParamTwoType,
			ParamTwoName,
			ParamTwoDefault
	)

Value:

    UE_DECLARE_ERROR_INTERNAL(DeclareApi, ErrorName, ErrorCode, ModuleName, FText::FromString(UTF8TEXT("{"#ModuleName"_F"#ErrorName"}")) ) \
    namespace UE::UnifiedError { namespace ModuleName { \
            struct F##ErrorName \
            {\
                ParamOneType ParamOneName;\
                ParamTwoType ParamTwoName;\
            };\
    }}\
	UE_DECLARE_ERRORSTRUCT_FEATURES(ModuleName, F##ErrorName);\
    inline void SerializeForLog(FCbWriter& Writer, const UE::UnifiedError::ModuleName::F##ErrorName& Context)\
    {\
        Writer.BeginObject();\
        Writer.AddString(ANSITEXTVIEW("$type"), TErrorStructFeatures<UE::UnifiedError::ModuleName::F##ErrorName>::GetErrorContextTypeNameAsString());\
        UE::SerializeLogFormat(Writer, FormatString); \
        UE::UnifiedError::SerializeBasicToCb(Writer, ANSITEXTVIEW(#ParamOneName), Context.ParamOneName);\
        UE::UnifiedError::SerializeBasicToCb(Writer, ANSITEXTVIEW(#ParamTwoName), Context.ParamTwoName);\
        Writer.EndObject();\
    }\
    namespace UE::UnifiedError { namespace ModuleName { \
    namespace ErrorName { \
            inline FError MakeError(ParamOneType ParamOneName = ParamOneDefault, ParamTwoType ParamTwoName = ParamTwoDefault) \
            { \
                FError Error = FError(UE::UnifiedError::ModuleName::GetStaticModuleId(), UE::UnifiedError::ModuleName::ErrorName::GetErrorCodeId(), UE::UnifiedError::ModuleName::ErrorName::GetStaticErrorDetails().GetReference()); \
                F##ErrorName Context = {ParamOneName, ParamTwoName}; \
                Error.PushErrorContext(MoveTemp(Context)); \
                return Error; \
            } \
    }}}

UE_DECLARE_ERRORSTRUCT_FEATURES

#define UE_DECLARE_ERRORSTRUCT_FEATURES	(		DetailsNameSpace,
			DetailsStructName
	)

Value:

    template<>\
    class TErrorStructFeatures<UE::UnifiedError::DetailsNameSpace::DetailsStructName>\
    {\
    public:\
        static const FAnsiStringView GetErrorDetailsLogEntryNameAsString() \
        {\
            return ANSITEXTVIEW(#DetailsNameSpace"_"#DetailsStructName);\
        }\
        static const FAnsiStringView GetErrorDetailsTypeNameAsString() \
        {\
            return ANSITEXTVIEW("TErrorDetails<"#DetailsNameSpace"::"#DetailsStructName">");\
        }\
        static const FAnsiStringView GetErrorContextTypeNameAsString() \
        {\
            return ANSITEXTVIEW(#DetailsNameSpace"::"#DetailsStructName);\
        }\
    };

UE_DECLARE_FERROR_DETAILS

#define UE_DECLARE_FERROR_DETAILS	(		DetailsNamespace,
			TypeName
	)

Value:

    public:\
	UE_DECLARE_ERROR_DETAILS_INTERNAL(DetailsNamespace, TypeName);\
    friend IErrorDetails* Create();\
    inline static IErrorDetails* Create()\
    {\
        return new TypeName();\
    }

UE_DECLARE_FERROR_DETAILS_ABSTRACT

#define UE_DECLARE_FERROR_DETAILS_ABSTRACT	(		DetailsNamespace,
			TypeName
	)

Value:

    public:\
	UE_DECLARE_ERROR_DETAILS_INTERNAL(DetailsNamespace, TypeName);

UE_DEFINE_ERROR

#define UE_DEFINE_ERROR	(		ErrorName,
			ModuleName
	)

Value:

    namespace UE::UnifiedError { namespace ModuleName { namespace ErrorName {\
            const int32 ErrorCodeId = UE::UnifiedError::ErrorRegistry::RegisterErrorCode(GetStaticErrorName(), UE::UnifiedError::ModuleName::GetStaticModuleId(), DeclaredErrorCode);\
            const FText DeclaredFormatString = GetFormatString(); \
            int32 GetErrorCodeId() \
            {\
                return ErrorCodeId;\
            }\
            FAnsiStringView GetStaticErrorName() \
            { \
                static const auto Reference = TStringLiteralWithSpacesReplaced(#ErrorName); \
                return Reference.Str; \
            }\
            TRefCountPtr<const FStaticErrorDetails> GetStaticErrorDetails() \
            {\
                static FStaticErrorDetails StaticErrorDetails(GetStaticErrorName(), UE::UnifiedError::ModuleName::GetStaticModuleName(), DeclaredFormatString);\
                return TRefCountPtr<const FStaticErrorDetails>(&StaticErrorDetails);\
            }\
            const FError& GetStaticError() \
            {\
                static FError StaticError = MakeError();\
                return StaticError;\
            }\
            bool OfType(const FError& Other) \
            {\
                return UE::UnifiedError::ModuleName::GetStaticModuleId() == Other.GetModuleId() && ErrorCodeId == Other.GetErrorCode(); \
            }\
    }}}

UE_DEFINE_ERROR_MODULE

#define UE_DEFINE_ERROR_MODULE

(

ModuleName

)

Value:

    namespace UE::UnifiedError { namespace ModuleName {\
        const int32 StaticModuleId = UE::UnifiedError::ErrorRegistry::RegisterModule(ANSITEXTVIEW(#ModuleName));\
        int32 GetStaticModuleId() { return StaticModuleId; }\
        FAnsiStringView GetStaticModuleName() \
        { \
            static const auto Reference = TStringLiteralWithSpacesReplaced(#ModuleName); \
            return Reference.Str; \
        }\
    }}

Function Documentation

CompileTimeHashString()

constexpr uint64 CompileTimeHashString ( const char *  String )

constexpr

LexToString()

CORE_API FString LexToString

(

const UE::UnifiedError::FError &

Error

)