server::handlers::ExceptionWithCode< Code > Class Template Reference

#include <userver/server/handlers/exceptions.hpp>

Detailed Description

template<HandlerErrorCode Code>
class server::handlers::ExceptionWithCode< Code >

Base class for handler exceptions. For common HandlerErrorCode values you can use more specific exception classes below. For less common HandlerErrorCode values, this class can be used directly.

Definition at line 307 of file exceptions.hpp.

Inheritance diagram for server::handlers::ExceptionWithCode< Code >:

Public Types
using	BaseType = ExceptionWithCode<kDefaultCode>
using	HandlerErrorCode = handlers::HandlerErrorCode
using	ServiceErrorCode = handlers::ServiceErrorCode
using	InternalMessage = handlers::InternalMessage
using	ExternalBody = handlers::ExternalBody
using	ExtraHeaders = handlers::ExtraHeaders

Public Member Functions
	ExceptionWithCode (const ExceptionWithCode< Code > &)=default
	ExceptionWithCode (ExceptionWithCode< Code > &&) noexcept=default
template<typename... Args>
	ExceptionWithCode (Args &&... args)
HandlerErrorCode	GetCode () const
const std::string &	GetServiceCode () const
bool	IsExternalErrorBodyFormatted () const
const std::string &	GetExternalErrorBody () const
const formats::json::Value &	GetDetails () const
const Headers &	GetExtraHeaders () const

Static Public Attributes
static constexpr HandlerErrorCode	kDefaultCode = Code

Member Typedef Documentation

BaseType

template<HandlerErrorCode Code>

using server::handlers::ExceptionWithCode< Code >::BaseType = ExceptionWithCode<kDefaultCode>

Definition at line 310 of file exceptions.hpp.

ExternalBody

using server::handlers::CustomHandlerException::ExternalBody = handlers::ExternalBody

inherited

Definition at line 201 of file exceptions.hpp.

ExtraHeaders

using server::handlers::CustomHandlerException::ExtraHeaders = handlers::ExtraHeaders

inherited

Definition at line 202 of file exceptions.hpp.

HandlerErrorCode

using server::handlers::CustomHandlerException::HandlerErrorCode = handlers::HandlerErrorCode

inherited

Definition at line 198 of file exceptions.hpp.

InternalMessage

using server::handlers::CustomHandlerException::InternalMessage = handlers::InternalMessage

inherited

Definition at line 200 of file exceptions.hpp.

ServiceErrorCode

using server::handlers::CustomHandlerException::ServiceErrorCode = handlers::ServiceErrorCode

inherited

Definition at line 199 of file exceptions.hpp.

Constructor & Destructor Documentation

ExceptionWithCode()

template<HandlerErrorCode Code>

template<typename... Args>

server::handlers::ExceptionWithCode< Code >::ExceptionWithCode ( Args &&... args )

inlineexplicit

See also

CustomHandlerException::CustomHandlerException for allowed args

Definition at line 317 of file exceptions.hpp.

Member Function Documentation

GetCode()

HandlerErrorCode server::handlers::CustomHandlerException::GetCode ( ) const

inlineinherited

Definition at line 287 of file exceptions.hpp.

GetDetails()

const formats::json::Value & server::handlers::CustomHandlerException::GetDetails ( ) const

inlineinherited

Definition at line 295 of file exceptions.hpp.

GetExternalErrorBody()

const std::string & server::handlers::CustomHandlerException::GetExternalErrorBody ( ) const

inlineinherited

Definition at line 293 of file exceptions.hpp.

GetExtraHeaders()

const Headers & server::handlers::CustomHandlerException::GetExtraHeaders ( ) const

inlineinherited

Definition at line 297 of file exceptions.hpp.

GetServiceCode()

const std::string & server::handlers::CustomHandlerException::GetServiceCode ( ) const

inlineinherited

Definition at line 289 of file exceptions.hpp.

IsExternalErrorBodyFormatted()

bool server::handlers::CustomHandlerException::IsExternalErrorBodyFormatted ( ) const

inlineinherited

Definition at line 291 of file exceptions.hpp.

Member Data Documentation

kDefaultCode

template<HandlerErrorCode Code>

HandlerErrorCode server::handlers::ExceptionWithCode< Code >::kDefaultCode = Code

staticconstexpr

Definition at line 309 of file exceptions.hpp.

---

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

• userver/server/handlers/exceptions.hpp