UE::UnifiedError::IErrorDetails Class Reference

#include <UnifiedError.h>

Inheritance diagram for UE::UnifiedError::IErrorDetails:

Public Member Functions
virtual	~IErrorDetails ()=default
virtual const FText	GetErrorFormatString (const FError &Error) const =0
	GetErrorFormatString; specifies the default error format string to be used when generating FError::GetErrorMessage. The format string can specify any property exposed by any encapsulated IErrorDetails::GetErrorProperties. Example: GetErrorProperties adds Name:"ModuleId" Value:10. GetErrorFormatString returns "Module id was {ModuleId}". Result "Module id was 10".
virtual TRefCountPtr< const IErrorDetails >	GetInnerErrorDetails () const
	GetInnerErrorDetails; Exposes inner error details to FError, if this ErrorDetails allows inner details.
virtual void	SetInnerErrorDetails (TRefCountPtr< const IErrorDetails > ErrorDetails)
	SetInnerErrorDetails; Exposes inner error details to FError, if this ErrorDetails allows inner details.
virtual uint64	GetErrorDetailsTypeId () const =0
	GetErrorDetialsTypeId; Simple type information for error details, generated using hash of details name See also: define FERROR_DETAILS.
virtual const FAnsiStringView	GetErrorDetailsTypeName () const =0
virtual const FAnsiStringView	GetErrorDetailsTypeNameForLog () const =0
virtual void	SerializeToCb (FCbWriter &Writer, const FError &Error) const =0
virtual bool	ShouldInclude (const EDetailFilter DetailFilter) const
Public Member Functions inherited from IRefCountedObject
virtual	~IRefCountedObject ()
virtual FReturnedRefCountValue	AddRef () const =0
virtual uint32	Release () const =0
virtual uint32	GetRefCount () const =0

Constructor & Destructor Documentation

~IErrorDetails()

virtual UE::UnifiedError::IErrorDetails::~IErrorDetails ( )

virtualdefault

Member Function Documentation

GetErrorDetailsTypeId()

virtual uint64 UE::UnifiedError::IErrorDetails::GetErrorDetailsTypeId ( ) const

pure virtual

GetErrorDetialsTypeId; Simple type information for error details, generated using hash of details name See also: define FERROR_DETAILS.

Returns

Implemented in UE::UnifiedError::TErrorDetails< T >.

GetErrorDetailsTypeName()

virtual const FAnsiStringView UE::UnifiedError::IErrorDetails::GetErrorDetailsTypeName ( ) const

pure virtual

Implemented in UE::UnifiedError::IoStore::FIoStoreErrorDetails, and UE::UnifiedError::TErrorDetails< T >.

GetErrorDetailsTypeNameForLog()

virtual const FAnsiStringView UE::UnifiedError::IErrorDetails::GetErrorDetailsTypeNameForLog ( ) const

pure virtual

Implemented in UE::UnifiedError::IoStore::FIoStoreErrorDetails, and UE::UnifiedError::TErrorDetails< T >.

GetErrorFormatString()

virtual const FText UE::UnifiedError::IErrorDetails::GetErrorFormatString ( const FError &  Error ) const

pure virtual

GetErrorFormatString; specifies the default error format string to be used when generating FError::GetErrorMessage. The format string can specify any property exposed by any encapsulated IErrorDetails::GetErrorProperties. Example: GetErrorProperties adds Name:"ModuleId" Value:10. GetErrorFormatString returns "Module id was {ModuleId}". Result "Module id was 10".

Parameters

Error

Returns

Implemented in UE::UnifiedError::FStaticErrorDetails, UE::UnifiedError::IoStore::FIoStoreErrorDetails, UE::UnifiedError::FAppendFormatStringDetails, and UE::UnifiedError::FDynamicErrorDetails.

GetInnerErrorDetails()

virtual TRefCountPtr< const IErrorDetails > UE::UnifiedError::IErrorDetails::GetInnerErrorDetails ( ) const

inlinevirtual

GetInnerErrorDetails; Exposes inner error details to FError, if this ErrorDetails allows inner details.

Returns

Reimplemented in UE::UnifiedError::FDynamicErrorDetails.

SerializeToCb()

virtual void UE::UnifiedError::IErrorDetails::SerializeToCb ( FCbWriter &  Writer, const FError &  Error  ) const

pure virtual

Implemented in UE::UnifiedError::FStaticErrorDetails, UE::UnifiedError::IoStore::FIoStoreErrorDetails, UE::UnifiedError::FAppendFormatStringDetails, and UE::UnifiedError::TErrorDetails< T >.

SetInnerErrorDetails()

virtual void UE::UnifiedError::IErrorDetails::SetInnerErrorDetails ( TRefCountPtr< const IErrorDetails >  ErrorDetails )

inlinevirtual

SetInnerErrorDetails; Exposes inner error details to FError, if this ErrorDetails allows inner details.

Returns

Reimplemented in UE::UnifiedError::FDynamicErrorDetails.

ShouldInclude()

virtual bool UE::UnifiedError::IErrorDetails::ShouldInclude ( const EDetailFilter  DetailFilter ) const

inlinevirtual

Reimplemented in UE::UnifiedError::FDynamicErrorDetails, UE::UnifiedError::FAppendFormatStringDetails, UE::UnifiedError::FStaticErrorDetails, and UE::UnifiedError::TErrorDetails< T >.

---

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

• Engine/Source/Runtime/Core/Public/Experimental/UnifiedError/UnifiedError.h