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);
  }
};

Definition at line 208 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 211 of file EonLogger.h.

      : logger(get_file(name, filename, pattern)) {}

Member Function Documentation

operator quill::Logger *()

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

inlinenoexcept

Definition at line 215 of file EonLogger.h.

{ return logger; }

operator->()

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

inlinenoexcept

Definition at line 217 of file EonLogger.h.

{ return logger; }

operator=()

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

inlinenoexcept

Definition at line 218 of file EonLogger.h.

                                               {
    logger = l;
    return *this;
  }

ptr()

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

inlinenodiscardnoexcept

Definition at line 222 of file EonLogger.h.

{ return logger; }

Member Data Documentation

logger

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

Definition at line 209 of file EonLogger.h.

{nullptr};

---

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

• /home/runner/work/eOn/eOn/include/eon/EonLogger.h