This exception class is used by RSC if any exception is thrown. More...

#include <RscException.hpp>

Inheritance diagram for Arp::Base::Rsc::Commons::RscException:

Public Member Functions
	RscException (RscError errorCode, const String &message)
	Constructs a RscException. More...

	RscException (RscError errorCode, const String &message, const Exception &innerException)
	Constructs a RscException. More...

template<typename... Args>
	RscException (RscError errorCode, const char *message, const Args &... args)
	Constructs a RscException More...

	RscException (const RscException &arg)
	Default copy constructor. More...

	RscException (RscException &&arg) noexcept
	Default move constructor. More...

RscException &	operator= (const RscException &arg)
	Default copy-assignment operator. More...

RscException &	operator= (RscException &&arg) noexcept
	Default move-assignment operator. More...

virtual	~RscException (void)
	Default destructor.

RscError	GetErrorCode (void) const
	Gets the RscError of this exception. More...

Impl &	GetImpl (void)
	For internal use only. More...

const Impl &	GetImpl (void) const

Public Member Functions inherited from Arp::Base::Commons::Exceptions::CommonExceptionBase
const Stacktrace &	GetStacktrace (void) const
	Gets the stackstrace of the point of creating this exception. More...

const StacktraceItems &	GetStacktraceItems (void) const
	Gets the stackstrace items of the point of creating this exception. More...

Public Member Functions inherited from Arp::Base::Core::Exception
	Exception (const Exception &arg)
	Default copy constructor.

	Exception (Exception &&arg) noexcept
	Default move constructor.

Exception &	operator= (const Exception &arg)
	Default copy-assignment operator.

Exception &	operator= (Exception &&arg) noexcept
	Default move-assignment operator.

virtual	~Exception (void)
	Default destructor.

	Exception (void)
	Constructs an empty instance of class Exception.

template<typename... Args>
	Exception (const char *message, Args &&... args)
	Constructs an instance of class Exception. More...

	Exception (const String &message)
	Constructs an instance of class Exception. More...

	Exception (String &&message)
	Constructs an instance of class Exception. More...

	Exception (const String &message, const Exception &innerException)
	Constructs an instance of class Exception. More...

	Exception (String &&message, const Exception &innerException)
	Constructs an instance of class Exception. More...

const String &	GetMessage (void) const
	Gets the error message of this exception. More...

ExceptionTypeId	GetTypeId (void) const
	Gets the type ID of this exception. More...

TypeCode	GetTypeCode (void) const
	Gets the type code of this exception. More...

bool	HasInnerException (void) const
	Determines if this exception has an inner exception. More...

const Exception &	GetInnerException (void) const
	Gets the inner exception of this exception. More...

String	ToString (void) const
	This operation should be used for logging and returns a reasonable description of the exception cause. More...

virtual Exception::Ptr	Clone (void) const
	This operation clones this instance polymorphically as a deep copy. More...

virtual String	Format (bool withInnerException) const
	Formats this exception using the given indent level. More...

Impl &	GetImpl (void)
	For internal use only.

const Impl &	GetImpl (void) const

Static Public Member Functions
static RscException	Create (RscError errorCode)
	Creates an exception of this type. More...

static RscException	Create (RscError errorCode, const Exception &innerExeption)
	Creates an exception of this type. More...

template<typename... Args>
static RscException	Create (RscError errorCode, const char *message, const Args &... args)
	Creates a RscException More...

Protected Member Functions
Exception::Ptr	Clone (void) const override
	This operation clones this instance polymorphically as a deep copy. More...

Protected Member Functions inherited from Arp::Base::Commons::Exceptions::CommonExceptionBase
	CommonExceptionBase (const CommonExceptionBase &arg)
	Default copy constructor.

	CommonExceptionBase (CommonExceptionBase &&arg) noexcept
	Default move constructor.

CommonExceptionBase &	operator= (const CommonExceptionBase &arg)
	Default copy-assignment operator.

CommonExceptionBase &	operator= (CommonExceptionBase &&arg) noexcept
	Default move-assignment operator.

	~CommonExceptionBase (void) override
	Default destructor.

	CommonExceptionBase (ExceptionTypeId typeId, String &&message, StackCounter stackCounter)
	Constructs an CommonExceptionBase instance. Used by derived classes only. More...

	CommonExceptionBase (ExceptionTypeId typeId, const String &message, StackCounter stackCounter)
	Constructs an CommonExceptionBase instance. Used by derived classes only. More...

	CommonExceptionBase (ExceptionTypeId typeId, String &&message, const Exception &innerException, StackCounter stackCounter)
	Constructs an CommonExceptionBase instance. Used by derived classes only. More...

	CommonExceptionBase (ExceptionTypeId typeId, const String &message, const Exception &innerException, StackCounter stackCounter)
	Constructs an CommonExceptionBase instance. Used by derived classes only. More...

String	Format (bool withInnerException) const override
	Formats this exception using the given indent level. More...

Protected Member Functions inherited from Arp::Base::Core::Exception
	Exception (ExceptionTypeId typeId, String &&message)
	Used by derived exception classes. More...

	Exception (ExceptionTypeId typeId, const String &message)
	Used by derived exception classes. More...

	Exception (ExceptionTypeId typeId, String &&message, const Exception &innerException)
	Used by derived exception classes. More...

	Exception (ExceptionTypeId typeId, const String &message, const Exception &innerException)
	Used by derived exception classes. More...

	Exception (String &&message, const Exception::Ptr &innerExceptionPtr)
	DEPRECATED. More...

String	Format (int indentLevel, bool withInnerException) const
	DEPRECATED. More...

virtual uint32	GetTypeCodeInternal (void) const
	DEPRECATED. More...

Additional Inherited Members
Public Types inherited from Arp::Base::Commons::Exceptions::CommonExceptionBase
using	StackCounter = Arp::Base::Commons::Runtime::StackCounter

using	Stacktrace = Arp::Base::Commons::Runtime::Stacktrace

using	StacktraceItems = Arp::Base::Commons::Runtime::Stacktrace::Items

Public Types inherited from Arp::Base::Core::Exception
using	Ptr = std::unique_ptr< Exception >
	The smart pointer type of this class.

using	TypeCode = std::underlying_type< Arp::Base::Core::ExceptionTypeId >::type
	The integral type of the type code.

Detailed Description

This exception class is used by RSC if any exception is thrown.

Constructor & Destructor Documentation

◆ RscException() [1/5]

Arp::Base::Rsc::Commons::RscException::RscException	(	RscError	errorCode,
		const String &	message
	)

Constructs a RscException.

Parameters

errorCode	The RscError of this exception.
message	The exception message.

◆ RscException() [2/5]

Arp::Base::Rsc::Commons::RscException::RscException	(	RscError	errorCode,
		const String &	message,
		const Exception &	innerException
	)

Constructs a RscException.

Parameters

errorCode	The RscError of this exception.
message	The exception message.
innerException	The inner exception.

◆ RscException() [3/5]

template<typename... Args>

Arp::Base::Rsc::Commons::RscException::RscException	(	RscError	errorCode,
		const char *	message,
		const Args &...	args
	)

inline

Constructs a RscException

Parameters

errorCode	The error code.
message	The message format.
...args	The message arguments.

Template Parameters

...Args The message argument types.

◆ RscException() [4/5]

Arp::Base::Rsc::Commons::RscException::RscException ( const RscException & arg )

default

Default copy constructor.

Parameters

arg	The argument to copy.

◆ RscException() [5/5]

Arp::Base::Rsc::Commons::RscException::RscException ( RscException && arg )

defaultnoexcept

Default move constructor.

Parameters

arg	The argument to move.

Member Function Documentation

◆ Clone()

Exception::Ptr Arp::Base::Rsc::Commons::RscException::Clone ( void ) const

overrideprotectedvirtual

This operation clones this instance polymorphically as a deep copy.

Never ever forget to override this operation in any derived exception class.

Returns: The cloned exception pointer.

Reimplemented from Arp::Base::Core::Exception.

◆ Create() [1/3]

RscException Arp::Base::Rsc::Commons::RscException::Create ( RscError errorCode )

static

Creates an exception of this type.

Parameters

errorCode The error code.

Returns: The create exception.

◆ Create() [2/3]

template<typename... Args>

RscException Arp::Base::Rsc::Commons::RscException::Create	(	RscError	errorCode,
		const char *	message,
		const Args &...	args
	)

inlinestatic

Creates a RscException

Parameters

errorCode	The error code.
message	The message format.
...args	The message arguments.

Template Parameters

...Args The message argument types.

Returns: The created RscException.

◆ Create() [3/3]

RscException Arp::Base::Rsc::Commons::RscException::Create	(	RscError	errorCode,
		const Exception &	innerException
	)

static

Creates an exception of this type.

Parameters

errorCode	The error code.
innerException	The inner exception.

Returns: The create exception.

◆ GetErrorCode()

RscError Arp::Base::Rsc::Commons::RscException::GetErrorCode ( void ) const

Gets the RscError of this exception.

Returns: The RscError of this exception.

◆ GetImpl()

const RscException::Impl & Arp::Base::Rsc::Commons::RscException::GetImpl ( void )

For internal use only.

Returns: The impl instance.

◆ operator=() [1/2]

RscException & Arp::Base::Rsc::Commons::RscException::operator= ( const RscException & arg )

default

Default copy-assignment operator.

Parameters

arg	The argument to assign.

Returns: This instance.

◆ operator=() [2/2]

RscException & Arp::Base::Rsc::Commons::RscException::operator= ( RscException && arg )

defaultnoexcept

Default move-assignment operator.

Parameters

arg	The argument to assign.

Returns: This instance.

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

Arp/Base/Rsc/Commons/RscException.hpp
Arp/Base/Rsc/Commons/RscException.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RscException() [1/5]

◆ RscException() [2/5]

◆ RscException() [3/5]

◆ RscException() [4/5]

◆ RscException() [5/5]

Member Function Documentation

◆ Clone()

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ GetErrorCode()

◆ GetImpl()

◆ operator=() [1/2]

◆ operator=() [2/2]