Loading...
Searching...
No Matches
eonc::log::FileScoped Struct Reference

RAII helper for file-based logging in a class. More...

#include <EonLogger.h>

Public Member Functions

 FileScoped (std::string_view name, std::string_view filename, std::string_view pattern="%(message)") noexcept
 operator quill::Logger * () const noexcept
quill::Logger * operator-> () const noexcept
FileScoped & operator= (quill::Logger *l) noexcept
quill::Logger * ptr () const noexcept

Public Attributes

quill::Logger * logger {nullptr}

Detailed Description

RAII helper for file-based logging in a class.

Similar to Scoped, but writes to a dedicated file. Useful for optimizer traces, detailed diagnostics, etc.

Example:

class Optimizer {
eonc::log::FileScoped m_log{"opt_trace", "optimizer.log"};
public:
void step() {
QUILL_LOG_INFO(m_log, "iteration {}", iter);
}
};
Abstract base of the structure optimizers.
Definition Optimizer.h:68
RAII helper for file-based logging in a class.
Definition EonLogger.h:274

Definition at line 274 of file EonLogger.h.

Constructor & Destructor Documentation

◆ FileScoped()

eonc::log::FileScoped::FileScoped ( std::string_view name,
std::string_view filename,
std::string_view pattern = "%(message)" )
inlinenoexcept

Definition at line 277 of file EonLogger.h.

279 : logger(get_file(name, filename, pattern)) {}
quill::Logger * get_file(std::string_view name, std::string_view filename, std::string_view pattern="%(message)")
Get or create a named logger with a file sink.
Definition EonLogger.h:178
quill::Logger * logger
Definition EonLogger.h:275

Member Function Documentation

◆ operator quill::Logger *()

eonc::log::FileScoped::operator quill::Logger * ( ) const
inlinenoexcept

Definition at line 281 of file EonLogger.h.

281{ return logger; }

◆ operator->()

quill::Logger * eonc::log::FileScoped::operator-> ( ) const
inlinenoexcept

Definition at line 283 of file EonLogger.h.

283{ return logger; }

◆ operator=()

FileScoped & eonc::log::FileScoped::operator= ( quill::Logger * l)
inlinenoexcept

Definition at line 284 of file EonLogger.h.

284 {
285 logger = l;
286 return *this;
287 }

◆ ptr()

quill::Logger * eonc::log::FileScoped::ptr ( ) const
inlinenodiscardnoexcept

Definition at line 288 of file EonLogger.h.

288{ return logger; }

Member Data Documentation

◆ logger

quill::Logger* eonc::log::FileScoped::logger {nullptr}

Definition at line 275 of file EonLogger.h.

275{nullptr};

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