logging Namespace Reference

Classes
class	Logger
	Thread-safe logger class for handling logging operations. More...

Enumerations
enum class	Level : std::uint8_t {   TRACE , DEBUG , INFO , WARNING ,   ERROR , FATAL , OFF }

Functions
std::string	getLevelString (const Level level) noexcept
	Converts a log level enum value to its string representation.
template<typename... Args>
void	log (Level level, const std::source_location &location, const std::string &formatStr, Args &&... args) noexcept
	Logs a formatted message with a specific log level and source location.

Variables
Logger	logger
	Externally available logger object.

Enumeration Type Documentation

Level

enum class logging::Level : std::uint8_t

strong

Enumerator
TRACE	Trace level for detailed debugging information.
DEBUG	Debug level for general debugging information.
INFO	Info level for informational messages.
WARNING	Warning level for potentially harmful situations.
ERROR	Error level for error events.
FATAL	Fatal level for severe error events.
OFF	Special level to disable all logging.

Definition at line 38 of file logging.h.

    {
        TRACE, ///< Trace level for detailed debugging information.
        DEBUG, ///< Debug level for general debugging information.
        INFO, ///< Info level for informational messages.
        WARNING, ///< Warning level for potentially harmful situations.
        ERROR, ///< Error level for error events.
        FATAL, ///< Fatal level for severe error events.
        OFF ///< Special level to disable all logging.
    };

Function Documentation

getLevelString()

std::string logging::getLevelString ( const Level  level )

noexcept

Converts a log level enum value to its string representation.

Parameters

level

The log level.

Returns

A string representing the log level.

Definition at line 144 of file logging.h.

    {
        switch (level)
        {
        case Level::TRACE:
            return "TRACE";
        case Level::DEBUG:
            return "DEBUG";
        case Level::INFO:
            return "INFO";
        case Level::WARNING:
            return "WARNING";
        case Level::ERROR:
            return "ERROR";
        case Level::FATAL:
            return "FATAL";
        case Level::OFF:
            return "OFF";
        default:
            return "UNKNOWN";
        }
    }

References DEBUG, ERROR, FATAL, INFO, OFF, TRACE, and WARNING.

Referenced by logging::Logger::log().

Here is the caller graph for this function:

log()

template<typename... Args>

void logging::log ( Level  level, const std::source_location &  location, const std::string &  formatStr, Args &&...  args  )

noexcept

Logs a formatted message with a specific log level and source location.

Template Parameters

Args	Variadic template for format arguments.

Parameters

level	The log level.
location	The source location of the log call.
formatStr	The format string.
args	The format arguments.

Definition at line 177 of file logging.h.

    {
        logger.log(level, location, formatStr, std::forward<Args>(args)...);
    }

References logging::Logger::log(), and logger.

Here is the call graph for this function:

Variable Documentation

logger

Logger logging::logger

Externally available logger object.

Definition at line 23 of file logging.cpp.

Referenced by fers_configure_logging(), fers_get_log_level(), fers_log(), fers_set_log_callback(), and log().