MySQL 8.4.5
Source Code Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
classic_protocol::borrowable::message::server::Error< Borrowed > Class Template Reference

Error message. More...

#include <classic_protocol_message.h>

Public Types

using string_type = std::conditional_t< Borrowed, std::string_view, std::string >
 

Public Member Functions

constexpr Error ()=default
 
constexpr Error (uint16_t error_code, string_type message, string_type sql_state="HY000")
 construct an Error message. More...
 
constexpr uint16_t error_code () const noexcept
 
constexpr void error_code (uint16_t code)
 
constexpr string_type sql_state () const
 
constexpr void sql_state (const string_type &state)
 
constexpr string_type message () const
 
constexpr void message (const string_type &msg)
 

Private Attributes

uint16_t error_code_ {0}
 
string_type message_
 
string_type sql_state_
 

Detailed Description

template<bool Borrowed>
class classic_protocol::borrowable::message::server::Error< Borrowed >

Error message.

Member Typedef Documentation

◆ string_type

template<bool Borrowed>
using classic_protocol::borrowable::message::server::Error< Borrowed >::string_type = std::conditional_t<Borrowed, std::string_view, std::string>

Constructor & Destructor Documentation

◆ Error() [1/2]

template<bool Borrowed>
constexpr classic_protocol::borrowable::message::server::Error< Borrowed >::Error ( )
constexprdefault

◆ Error() [2/2]

template<bool Borrowed>
constexpr classic_protocol::borrowable::message::server::Error< Borrowed >::Error ( uint16_t  error_code,
string_type  message,
string_type  sql_state = "HY000" 
)
inlineconstexpr

construct an Error message.

Parameters
error_codeerror code
messageerror message
sql_stateSQL state

Member Function Documentation

◆ error_code() [1/2]

template<bool Borrowed>
constexpr uint16_t classic_protocol::borrowable::message::server::Error< Borrowed >::error_code ( ) const
inlineconstexprnoexcept

◆ error_code() [2/2]

template<bool Borrowed>
constexpr void classic_protocol::borrowable::message::server::Error< Borrowed >::error_code ( uint16_t  code)
inlineconstexpr

◆ message() [1/2]

template<bool Borrowed>
constexpr string_type classic_protocol::borrowable::message::server::Error< Borrowed >::message ( ) const
inlineconstexpr

◆ message() [2/2]

template<bool Borrowed>
constexpr void classic_protocol::borrowable::message::server::Error< Borrowed >::message ( const string_type msg)
inlineconstexpr

◆ sql_state() [1/2]

template<bool Borrowed>
constexpr string_type classic_protocol::borrowable::message::server::Error< Borrowed >::sql_state ( ) const
inlineconstexpr

◆ sql_state() [2/2]

template<bool Borrowed>
constexpr void classic_protocol::borrowable::message::server::Error< Borrowed >::sql_state ( const string_type state)
inlineconstexpr

Member Data Documentation

◆ error_code_

template<bool Borrowed>
uint16_t classic_protocol::borrowable::message::server::Error< Borrowed >::error_code_ {0}
private

◆ message_

template<bool Borrowed>
string_type classic_protocol::borrowable::message::server::Error< Borrowed >::message_
private

◆ sql_state_

template<bool Borrowed>
string_type classic_protocol::borrowable::message::server::Error< Borrowed >::sql_state_
private

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