scl::exceptions::InvalidEitherAccess Class Reference

Exception class used when attempting to access the wrong type stored in an scl::utils::Either. More...

#include "InvalidEitherAccess.h"

Inheritance diagram for scl::exceptions::InvalidEitherAccess:

Collaboration diagram for scl::exceptions::InvalidEitherAccess:

Public Member Functions
const char *const	type () const noexcept override
	A string describing the name of the exception class. More...
Public Member Functions inherited from scl::exceptions::Exception
template<class T >
	Exception (T &&reason)
	Construct an scl::exceptions::Exception from an error message. More...
const char *const	reason () const override
	Retrieve the reason. More...
const char *	what () const noexcept override
	Override that uses the user defined reason. More...

Static Public Member Functions
static InvalidEitherAccess	leftWhenRight ()
	Helper function that creates an InvaidEitherAccess when trying to access Lhs when Rhs is active. More...
static InvalidEitherAccess	rightWhenLeft ()
	Helper function that creates an InvaidEitherAccess when trying to access Rhs when Lhs is active. More...

Additional Inherited Members
Protected Attributes inherited from scl::exceptions::Exception
const char *const	_reason = ""
	The error message that comes with this Exception. More...

Detailed Description

Exception class used when attempting to access the wrong type stored in an scl::utils::Either.

Definition at line 10 of file InvalidEitherAccess.h.

Member Function Documentation

leftWhenRight()

static InvalidEitherAccess scl::exceptions::InvalidEitherAccess::leftWhenRight ( )

inlinestatic

Helper function that creates an InvaidEitherAccess when trying to access Lhs when Rhs is active.

Returns

the exception

Definition at line 21 of file InvalidEitherAccess.h.

rightWhenLeft()

static InvalidEitherAccess scl::exceptions::InvalidEitherAccess::rightWhenLeft ( )

inlinestatic

Helper function that creates an InvaidEitherAccess when trying to access Rhs when Lhs is active.

Returns

the exception

Definition at line 29 of file InvalidEitherAccess.h.

type()

const char* const scl::exceptions::InvalidEitherAccess::type ( ) const

inlineoverridevirtualnoexcept

A string describing the name of the exception class.

Returns

the fully qualified name of this class

Reimplemented from scl::exceptions::Exception.

Definition at line 13 of file InvalidEitherAccess.h.

---

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

• include/scl/exceptions/InvalidEitherAccess.h