irsol::protocol::Error Struct Reference

Represents an error response message from the server. More...

#include <error.hpp>

Public Member Functions
std::string	toString () const
	Converts the error to a human-readable string.

Static Public Member Functions
template<typename T , std::enable_if_t< irsol::traits::is_type_in_variant_v< T, InMessage >, int > = 0>
static Error	from (const T &msg, const std::string &description)
	Creates an error from a specific incoming message type.
static Error	from (const InMessage &message, const std::string &description)
	Creates an error from a generic InMessage variant.

Public Attributes
std::string	identifier
	The identifier related to the failed operation (e.g., the variable or command name).
InMessageKind	source
	The kind of input message that triggered the error.
std::string	description
	A descriptive message explaining the cause of the error.

Private Member Functions
	Error (const std::string &identifier, InMessageKind source, const std::string &description)

Detailed Description

Represents an error response message from the server.

An Error message is generated when a protocol input message fails to be parsed, interpreted, or executed correctly. It includes a reference identifier (if available), the type of message that caused the error, and a human-readable description of the issue.

Can be stored in a irsol::protocol::OutMessage variant.

Definition at line 35 of file error.hpp.

Constructor & Destructor Documentation

Error()

irsol::protocol::Error::Error ( const std::string &  identifier, InMessageKind  source, const std::string &  description  )

private

Definition at line 10 of file error.cpp.

  : identifier(utils::validateIdentifier(identifier)), source(source), description(description)
{}

Member Function Documentation

from() [1/2]

Error irsol::protocol::Error::from ( const InMessage &  message, const std::string &  description  )

static

Creates an error from a generic InMessage variant.

Parameters

message	The original message variant.
description	The explanation of the error.

Returns

An Error instance describing the issue.

Definition at line 25 of file error.cpp.

{
  return std::visit(
    [&description](auto&& value) -> Error {
      using T = std::decay_t<decltype(value)>;
      return Error::from<T>(value, description);
    },
    message);
}

from() [2/2]

template<typename T , std::enable_if_t< irsol::traits::is_type_in_variant_v< T, InMessage >, int > = 0>

static Error irsol::protocol::Error::from ( const T &  msg, const std::string &  description  )

inlinestatic

Creates an error from a specific incoming message type.

This templated overload supports Assignment, Command, and Inquiry input types.

Template Parameters

T	The incoming message type.

Parameters

msg	The message that caused the error.
description	The explanation of the error.

Returns

An Error instance describing the issue.

Definition at line 63 of file error.hpp.

  {
    if constexpr(std::is_same_v<T, Assignment>) {
      return Error(msg.identifier, InMessageKind::ASSIGNMENT, description);
    } else if constexpr(std::is_same_v<T, Inquiry>) {
      return Error(msg.identifier, InMessageKind::INQUIRY, description);
    } else if constexpr(std::is_same_v<T, Command>) {
      return Error(msg.identifier, InMessageKind::COMMAND, description);
    } else {
      IRSOL_MISSING_TEMPLATE_SPECIALIZATION(T, "Error::from<T>()");
    }
  }

toString()

std::string irsol::protocol::Error::toString

(

)

const

Converts the error to a human-readable string.

Returns

A string representation of the error.

Definition at line 15 of file error.cpp.

{
  std::ostringstream oss;
  oss << "Error{"
      << "identifier: '" << identifier << "', source: " << InMessageKindToString(source)
      << ", description: '" << description << "'}";
  return oss.str();
}

Member Data Documentation

description

std::string irsol::protocol::Error::description

A descriptive message explaining the cause of the error.

Definition at line 44 of file error.hpp.

identifier

std::string irsol::protocol::Error::identifier

The identifier related to the failed operation (e.g., the variable or command name).

Definition at line 38 of file error.hpp.

source

InMessageKind irsol::protocol::Error::source

The kind of input message that triggered the error.

Definition at line 41 of file error.hpp.

---

The documentation for this struct was generated from the following files:

• src/irsol/include/irsol/protocol/message/error.hpp
• src/irsol/lib/irsol/protocol/message/error.cpp