errors 0.6.3
Loading...
Searching...
No Matches
errors::impl::code_error< Code > Class Template Reference

An error that has a code. More...

#include <errors/impl/code_error.hpp>

Inheritance diagram for errors::impl::code_error< Code >:
Collaboration diagram for errors::impl::code_error< Code >:

Public Member Functions

 code_error (const std::string &message, Code code, source_location location)
 Constructor with message, code and source_location.
 
const char * what () const noexcept override
 Get error message.
 
- Public Member Functions inherited from errors::impl::runtime_error
 runtime_error (std::string msg, source_location loc)
 Constructor with message and source_location.
 
const char * what () const noexcept override
 Get error message.
 
- Public Member Functions inherited from errors::impl::error_without_cause
const error_ptrcause () const &noexcept override
 Get cause of this error, if any.
 
error_ptr cause () &&noexcept override
 Transfer the ownership of cause of this error, if any.
 
 base_error (source_location loc)
 Constructor with source_location.
 
- Public Member Functions inherited from errors::impl::base_error
 base_error (source_location loc)
 Constructor with source_location.
 
std::optional< source_locationlocation () const noexcept override
 Get the source location of this error, if any.
 
- Public Member Functions inherited from errors::error
- Public Member Functions inherited from errors::detail::interface
 interface (const interface &)=delete
 
 interface (interface &&)=delete
 
interfaceoperator= (interface &&)=delete
 
interfaceoperator= (const interface &)=delete
 

Public Attributes

Code code
 The error code.
 
- Public Attributes inherited from errors::impl::runtime_error
std::string message
 The error message.
 

Detailed Description

template<typename Code>
class errors::impl::code_error< Code >

An error that has a code.

Template Parameters
CodeThe type of the code.

This class is used to create an error that has a code.

Constructor & Destructor Documentation

◆ code_error()

template<typename Code >
errors::impl::code_error< Code >::code_error ( const std::string & message,
Code code,
source_location location )
inline

Constructor with message, code and source_location.

Parameters
messageThe message.
codeThe code.
locationThe source location.

Member Function Documentation

◆ what()

template<typename Code >
const char * errors::impl::code_error< Code >::what ( ) const
inlineoverridevirtualnoexcept

Get error message.

Returns
A c-style string, which is an error message. It should never be NULL, but it can be an empty string.

This method works just like std::exception::what, you should print all the context which is useful for debugging in this method except for the source location.

Implements errors::error.


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