kcenon::logger::utils::error_context Struct Reference

Structured error context for debugging. More...

#include <error_handling_utils.h>

Collaboration diagram for kcenon::logger::utils::error_context:

Public Member Functions
	error_context (logger_error_code error_code, std::string error_message, std::string op="", std::string file="", int line=0)
	Construct error context with manual location information.
std::string	to_string () const
	Convert error context to a formatted string.

Public Attributes
logger_error_code	code
std::string	message
std::string	operation
std::string	source_file
int	source_line
std::string	function_name
std::chrono::system_clock::time_point	timestamp

Detailed Description

Structured error context for debugging.

Provides additional context information for errors to aid in debugging and troubleshooting. This context can be used to track where and when errors occurred.

When C++20 source_location is available, location information is captured automatically. Otherwise, it can be provided manually.

Definition at line 42 of file error_handling_utils.h.

Constructor & Destructor Documentation

error_context()

kcenon::logger::utils::error_context::error_context ( logger_error_code error_code, std::string error_message, std::string op = "", std::string file = "", int line = 0 )

inline

Construct error context with manual location information.

Parameters

error_code	The logger error code
error_message	Detailed error message
op	Operation being performed (optional)
file	Source file name (optional)
line	Source line number (optional)

Definition at line 80 of file error_handling_utils.h.

      : code(error_code),
        message(std::move(error_message)),
        operation(std::move(op)),
        source_file(std::move(file)),
        source_line(line),
        function_name(""),
        timestamp(std::chrono::system_clock::now()) {}

Member Function Documentation

to_string()

std::string kcenon::logger::utils::error_context::to_string ( ) const

inline

Convert error context to a formatted string.

Returns

Formatted error message with context

Definition at line 99 of file error_handling_utils.h.

                                {
        std::ostringstream oss;
        oss << "[" << logger_error_to_string(code) << "]";
        if (!message.empty()) {
            oss << " " << message;
        }
        if (!operation.empty()) {
            oss << " (during: " << operation << ")";
        }
        if (!source_file.empty()) {
            oss << " at " << source_file;
            if (source_line > 0) {
                oss << ":" << source_line;
            }
        }
        if (!function_name.empty()) {
            oss << " in " << function_name << "()";
        }
        return oss.str();
    }

References code, function_name, kcenon::logger::logger_error_to_string(), message, operation, source_file, and source_line.

Referenced by kcenon::logger::utils::log_error_context().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

code

logger_error_code kcenon::logger::utils::error_context::code

Definition at line 43 of file error_handling_utils.h.

Referenced by to_string().

function_name

std::string kcenon::logger::utils::error_context::function_name

Definition at line 48 of file error_handling_utils.h.

Referenced by to_string().

message

std::string kcenon::logger::utils::error_context::message

Definition at line 44 of file error_handling_utils.h.

Referenced by to_string().

operation

std::string kcenon::logger::utils::error_context::operation

Definition at line 45 of file error_handling_utils.h.

Referenced by to_string().

source_file

std::string kcenon::logger::utils::error_context::source_file

Definition at line 46 of file error_handling_utils.h.

Referenced by to_string().

source_line

int kcenon::logger::utils::error_context::source_line

Definition at line 47 of file error_handling_utils.h.

Referenced by to_string().

timestamp

std::chrono::system_clock::time_point kcenon::logger::utils::error_context::timestamp

Definition at line 49 of file error_handling_utils.h.

---

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

• include/kcenon/logger/utils/error_handling_utils.h