OGLplus  (0.59.0) a C++ wrapper for rendering APIs

eagine::logger Class Reference

Standalone logger object type. More...

#include <eagine/logging/logger.hpp>

Public Member Functions

template<log_event_severity severity>
auto log (log_event_severity_constant< severity > level, string_view format) noexcept -> entry_type< severity >
 Returns a log entry with the specified log_event_severity level. More...
 
auto log (log_event_severity severity, string_view format) noexcept
 Returns a log entry with the specified log_event_severity. More...
 
auto debug_stream () noexcept
 Returns a log entry stream for debug messages. More...
 
auto error_stream () noexcept
 Returns a log entry stream for error messages. More...
 
auto chart_sample (identifier series, float value) noexcept -> logger &
 Stores a new value in the specified chart data series.
 
template<typename T , typename U >
auto chart_sample (identifier series, const tagged_quantity< T, U > &qty) noexcept -> std::enable_if_t< std::is_convertible_v< T, float >, logger & >
 Stores a new value in the specified chart data series.
 
template<typename T , typename P >
auto chart_sample (identifier series, const valid_if< T, P > &opt_value) noexcept -> logger &
 Stores a new value in the specified chart data series.
 
auto fatal (string_view format) noexcept
 Returns a fatal error log entry. More...
 
auto error (string_view format) noexcept
 Returns an error log entry. More...
 
auto warning (string_view format) noexcept
 Returns a warning log entry. More...
 
auto info (string_view format) noexcept
 Returns an informational log entry. More...
 
auto stat (string_view format) noexcept
 Returns a statistic log entry. More...
 
auto debug (string_view format) noexcept
 Returns a debugging log entry. More...
 
auto trace (string_view format) noexcept
 Returns a tracing log entry. More...
 
auto backtrace (string_view format) noexcept
 Returns a backtracing log entry. More...
 
- Public Member Functions inherited from eagine::named_logging_object< logger_shared_backend_getter >
 named_logging_object (identifier id, logger_shared_backend_getter backend_getter) noexcept
 Constructor from identifier and backend_getter object. More...
 
 named_logging_object (identifier id, const named_logging_object &parent) noexcept
 Constructor from logger id and parent logging object.
 
 named_logging_object () noexcept=default
 Construct logging object without backend.
 
 named_logging_object (named_logging_object &&temp) noexcept
 Move constructor.
 
 named_logging_object (const named_logging_object &that) noexcept
 Copy constructor.
 
auto operator= (named_logging_object &&) noexcept -> named_logging_object &=default
 Move assignment operator.
 
auto operator= (const named_logging_object &) -> named_logging_object &=default
 Copy assignment operator.
 
constexpr auto object_id () const noexcept
 Returns the identifier of this logging object.
 
void object_description (string_view display_name, string_view description) noexcept
 Sets the human-readable name and description of this object.
 
auto log_fatal (string_view format) noexcept
 Create a log message entry for fatal error, with specified format. More...
 
auto log_error (string_view format) noexcept
 Create a log message entry for error, with specified format. More...
 
auto log_warning (string_view format) noexcept
 Create a log message entry for warning, with specified format. More...
 
auto log_info (string_view format) noexcept
 Create a log message entry for information, with specified format. More...
 
auto log_stat (string_view format) noexcept
 Create a log message entry for statistic, with specified format. More...
 
auto log_debug (string_view format) noexcept
 Create a log message entry for debugging, with specified format. More...
 
auto log_trace (string_view format) noexcept
 Create a log message entry for tracing, with specified format. More...
 
auto log_backtrace (string_view format) noexcept
 Create a log message entry for backtracing, with specified format. More...
 
auto log_debug_stream () noexcept
 Returns a log entry stream for debug messages. More...
 
auto log_error_stream () noexcept
 Returns a log entry stream for error messages. More...
 
auto log_chart_sample (identifier series, float value) noexcept -> named_logging_object &
 Stores a new value in the specified chart data series.
 
auto log_chart_sample (identifier series, const tagged_quantity< T, U > &qty) noexcept -> std::enable_if_t< std::is_convertible_v< T, float >, named_logging_object & >
 Stores a new value in the specified chart data series.
 
auto log_chart_sample (identifier series, const valid_if< T, P > &opt_value) noexcept -> named_logging_object &
 Stores a new value in the specified chart data series.
 
- Public Member Functions inherited from eagine::basic_logger< logger_shared_backend_getter >
auto backend () noexcept
 Returns a pointer to the backend of this logger object.
 
auto instance_id () const noexcept -> logger_instance_id
 Returns the unique id of this logger instance.
 

Additional Inherited Members

- Public Types inherited from eagine::named_logging_object< logger_shared_backend_getter >
using entry_type = std::conditional_t< is_log_level_enabled_v< severity >, log_entry, no_log_entry >
 The entry type for the specified log_event_severity. More...
 
- Public Types inherited from eagine::basic_logger< logger_shared_backend_getter >
using entry_type = std::conditional_t< is_log_level_enabled_v< severity >, log_entry, no_log_entry >
 The entry type for the specified log_event_severity. More...
 

Detailed Description

Standalone logger object type.

See also
named_logging_object

Consider using named_logging_object instead of logger where appropriate.

Member Function Documentation

◆ backtrace()

auto eagine::logger::backtrace ( string_view  format)
inlinenoexcept

Returns a backtracing log entry.

Parameters
formatthe log message format string.
See also
log

◆ debug()

auto eagine::logger::debug ( string_view  format)
inlinenoexcept

Returns a debugging log entry.

Parameters
formatthe log message format string.
See also
log

◆ debug_stream()

auto eagine::logger::debug_stream ( )
inlinenoexcept

Returns a log entry stream for debug messages.

See also
log_event_severity
stream_log_entry

◆ error()

auto eagine::logger::error ( string_view  format)
inlinenoexcept

Returns an error log entry.

Parameters
formatthe log message format string.
See also
log

◆ error_stream()

auto eagine::logger::error_stream ( )
inlinenoexcept

Returns a log entry stream for error messages.

See also
log_event_severity
stream_log_entry

◆ fatal()

auto eagine::logger::fatal ( string_view  format)
inlinenoexcept

Returns a fatal error log entry.

Parameters
formatthe log message format string.
See also
log

◆ info()

auto eagine::logger::info ( string_view  format)
inlinenoexcept

Returns an informational log entry.

Parameters
formatthe log message format string.
See also
log

◆ log() [1/2]

auto eagine::logger::log ( log_event_severity  severity,
string_view  format 
)
inlinenoexcept

Returns a log entry with the specified log_event_severity.

Parameters
formatthe log message format string.
See also
fatal
error
warning
info
stat
debug
trace
backtrace

◆ log() [2/2]

template<log_event_severity severity>
auto eagine::logger::log ( log_event_severity_constant< severity >  level,
string_view  format 
) -> entry_type<severity>
inlinenoexcept

Returns a log entry with the specified log_event_severity level.

Parameters
formatthe log message format string.
See also
fatal
error
warning
info
stat
debug
trace
backtrace
log_tagged

◆ stat()

auto eagine::logger::stat ( string_view  format)
inlinenoexcept

Returns a statistic log entry.

Parameters
formatthe log message format string.
See also
log

◆ trace()

auto eagine::logger::trace ( string_view  format)
inlinenoexcept

Returns a tracing log entry.

Parameters
formatthe log message format string.
See also
log

◆ warning()

auto eagine::logger::warning ( string_view  format)
inlinenoexcept

Returns a warning log entry.

Parameters
formatthe log message format string.
See also
log

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

Copyright © 2015-2021 Matúš Chochlík.
<chochlik -at -gmail.com>
Documentation generated on Tue Apr 13 2021 by Doxygen (version 1.8.17).