Error.hpp File Reference

This file contains the list of errors that can occur in the application. More...

#include <string_view>

Go to the source code of this file.

Macros
#define	_ENUMERATE_ERRORS
	A macro that enumerates the errors that can occur in the application.
#define	_ENUMERATE_ERROR(x)

Enumerations
enum class	Cluedo::Error { _ENUMERATE_ERROR , _ENUMERATE_ERRORS }

Functions
std::string_view	Cluedo::format_as (Error error)

Detailed Description

This file contains the list of errors that can occur in the application.

Macro Definition Documentation

_ENUMERATE_ERROR

#define _ENUMERATE_ERROR

(

x

)

Value:

x,

_ENUMERATE_ERRORS

#define _ENUMERATE_ERRORS

Value:

  _ENUMERATE_ERROR(InvalidNumberOfPlayers) \
  _ENUMERATE_ERROR(InvalidNumberOfCards)   \
  _ENUMERATE_ERROR(InvalidInformation)

A macro that enumerates the errors that can occur in the application.

Enumeration Type Documentation

Error

enum class Cluedo::Error

strong

The list of errors that can occur in the application.

Function Documentation

format_as()

std::string_view Cluedo::format_as

(

Error

error

)

Formats the error as a string.

Note

This function is meant to be used by the {fmt} library to format the errors correctly.