StormByte::Exception Class Reference

Base class for exceptions in the StormByte library. More...

#include <exception.hxx>

Inheritance diagram for StormByte::Exception:

Public Member Functions
	Exception (const std::string &message)
	Constructor.
	Exception (std::string &&message)
	Constructor.
template<typename... Args>
	Exception (std::format_string< Args... > fmt, Args &&... args)
	Constructor forwards the message to the std::format function.
	Exception (const Exception &e)
	Copy constructor.
	Exception (Exception &&e) noexcept
	Move constructor.
virtual	~Exception () noexcept
	Destructor.
Exception &	operator= (const Exception &e)
	Copy assignment operator.
Exception &	operator= (Exception &&e) noexcept
	Move assignment operator.
virtual const char *	what () const noexcept
	Gets the exception message.

Detailed Description

Base class for exceptions in the StormByte library.

The Exception class provides a consistent mechanism for handling errors across library boundaries. It ensures compatibility with both Windows and Linux platforms and avoids issues with std::string across DLL boundaries by using const char* for internal storage.

Constructor & Destructor Documentation

Exception() [1/5]

StormByte::Exception::Exception ( const std::string &  message )

explicit

Constructor.

Parameters

message

Exception message as a std::string

Exception() [2/5]

StormByte::Exception::Exception ( std::string &&  message )

explicit

Constructor.

Parameters

message

Exception message as a moved std::string

Exception() [3/5]

template<typename... Args>

StormByte::Exception::Exception ( std::format_string< Args... >  fmt, Args &&...  args  )

inline

Constructor forwards the message to the std::format function.

Template Parameters

Args	Format argument types

Parameters

fmt	Format string
args	Arguments for formatting

If no arguments are provided, the format string is used as the exception message directly.

Exception() [4/5]

StormByte::Exception::Exception

(

const Exception &

e

)

Copy constructor.

Parameters

e	Exception to copy

Exception() [5/5]

StormByte::Exception::Exception ( Exception &&  e )

noexcept

Move constructor.

Parameters

e	Exception to move

Member Function Documentation

operator=() [1/2]

Exception & StormByte::Exception::operator=

(

const Exception &

e

)

Copy assignment operator.

Parameters

e	Exception to copy

Returns

Reference to this exception

operator=() [2/2]

Exception & StormByte::Exception::operator= ( Exception &&  e )

noexcept

Move assignment operator.

Parameters

e	Exception to move

Returns

Reference to this exception

what()

virtual const char * StormByte::Exception::what ( ) const

virtualnoexcept

Gets the exception message.

Returns

Exception message as const char*

---

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

• /home/runner/work/StormByte/StormByte/lib/public/StormByte/exception.hxx