LiteFX::ArgumentOutOfRangeException Class Reference

An exception that is thrown, if a provided argument is not within the expected range. More...

#include <exceptions.hpp>

Inherits LiteFX::Exception.

Public Member Functions
	ArgumentOutOfRangeException (std::string_view argument)
	Initializes a new exception.
	ArgumentOutOfRangeException (std::string_view argument, std::string_view message)
	Initializes a new exception.
template<typename ... TArgs>
	ArgumentOutOfRangeException (std::string_view argument, std::format_string< TArgs... > format, TArgs &&... args)
	Initializes a new exception.
template<typename T , typename ... TArgs>
	ArgumentOutOfRangeException (std::string_view argument, std::pair< T, T > validRange, T value, std::format_string< TArgs... > format, TArgs &&... args)
	Initializes a new exception.
	ArgumentOutOfRangeException (const ArgumentOutOfRangeException &)=default
	ArgumentOutOfRangeException (ArgumentOutOfRangeException &&) noexcept=default
	~ArgumentOutOfRangeException () noexcept override=default
ArgumentOutOfRangeException &	operator= (const ArgumentOutOfRangeException &)=default
ArgumentOutOfRangeException &	operator= (ArgumentOutOfRangeException &&) noexcept=default
const std::string &	argument () const noexcept
	Gets the name of the argument that was out of range.
Public Member Functions inherited from LiteFX::Exception
	Exception (const Exception &)=default
	Exception (Exception &&) noexcept=default
	~Exception () noexcept override=default
Exception &	operator= (const Exception &)=default
Exception &	operator= (Exception &&) noexcept=default
const std::source_location &	location () const noexcept
	Gets the source location that identifies where the exception has been thrown.
const std::stacktrace &	trace () const noexcept
	Gets the stack trace leading to the exception.

Additional Inherited Members
Protected Member Functions inherited from LiteFX::Exception
	Exception (const std::string &message, const std::source_location &location, std::stacktrace trace)
	Initializes the exception.

Detailed Description

An exception that is thrown, if a provided argument is not within the expected range.

Constructor & Destructor Documentation

ArgumentOutOfRangeException() [1/6]

LiteFX::ArgumentOutOfRangeException::ArgumentOutOfRangeException ( std::string_view argument )

inlineexplicit

Initializes a new exception.

Parameters

argument

The name of the argument that was out of range.

ArgumentOutOfRangeException() [2/6]

LiteFX::ArgumentOutOfRangeException::ArgumentOutOfRangeException ( std::string_view argument, std::string_view message )

inlineexplicit

Initializes a new exception.

Parameters

argument	The name of the argument that was out of range.
message	The error message.

ArgumentOutOfRangeException() [3/6]

template<typename ... TArgs>

LiteFX::ArgumentOutOfRangeException::ArgumentOutOfRangeException ( std::string_view argument, std::format_string< TArgs... > format, TArgs &&... args )

inlineexplicit

Initializes a new exception.

Parameters

argument	The name of the argument that was out of range.
format	The format string for the error message.
args	The arguments passed to the error message format string.

ArgumentOutOfRangeException() [4/6]

template<typename T , typename ... TArgs>

LiteFX::ArgumentOutOfRangeException::ArgumentOutOfRangeException ( std::string_view argument, std::pair< T, T > validRange, T value, std::format_string< TArgs... > format, TArgs &&... args )

inlineexplicit

Initializes a new exception.

Template Parameters

T	The type of the argument that was out of range.

Parameters

argument	The name of the argument that was out of range.
validRange	The lower bound and upper bound of the valid range.
value	The actual value of provided to the argument.
format	The format string for the error message.
args	The arguments passed to the error message format string.

ArgumentOutOfRangeException() [5/6]

LiteFX::ArgumentOutOfRangeException::ArgumentOutOfRangeException ( const ArgumentOutOfRangeException & )

default

ArgumentOutOfRangeException() [6/6]

LiteFX::ArgumentOutOfRangeException::ArgumentOutOfRangeException ( ArgumentOutOfRangeException && )

defaultnoexcept

~ArgumentOutOfRangeException()

LiteFX::ArgumentOutOfRangeException::~ArgumentOutOfRangeException ( )

overridedefaultnoexcept

Member Function Documentation

argument()

const std::string & LiteFX::ArgumentOutOfRangeException::argument ( ) const

inlinenoexcept

Gets the name of the argument that was out of range.

Returns

The name of the invalid out of range.

operator=() [1/2]

ArgumentOutOfRangeException & LiteFX::ArgumentOutOfRangeException::operator= ( ArgumentOutOfRangeException && )

defaultnoexcept

operator=() [2/2]

ArgumentOutOfRangeException & LiteFX::ArgumentOutOfRangeException::operator= ( const ArgumentOutOfRangeException & )

default