Convenience class for setting a single context field with RAII. More...

#include <log_context_scope.h>

Collaboration diagram for kcenon::logger::scoped_context:

Public Member Functions
	scoped_context (const std::string &key, const std::string &value)
	Construct with string value.

	scoped_context (const std::string &key, int64_t value)
	Construct with integer value.

	scoped_context (const std::string &key, int value)
	Construct with int value (converts to int64_t)

	scoped_context (const std::string &key, double value)
	Construct with double value.

	scoped_context (const std::string &key, bool value)
	Construct with boolean value.

	~scoped_context ()
	Destructor - restores or removes the context field.

	scoped_context (const scoped_context &)=delete

scoped_context &	operator= (const scoped_context &)=delete

	scoped_context (scoped_context &&)=delete

scoped_context &	operator= (scoped_context &&)=delete

Private Attributes
std::string	key_

log_value	previous_value_

bool	had_previous_

Detailed Description

Convenience class for setting a single context field with RAII.

Provides a simpler interface for setting a single context field that will be automatically removed when the scope exits.

Examples: structured_logging_example.cpp.

Definition at line 347 of file log_context_scope.h.

Constructor & Destructor Documentation

◆ scoped_context() [1/7]

kcenon::logger::scoped_context::scoped_context	(	const std::string &	key,
		const std::string &	value )

inline

Construct with string value.

Examples: /home/runner/work/logger_system/logger_system/include/kcenon/logger/core/log_context_scope.h.

Definition at line 352 of file log_context_scope.h.

        : key_(key), had_previous_(false) {
        auto prev = log_context_storage::get_field(key);
        if (prev) {
            had_previous_ = true;
            previous_value_ = *prev;
        }
        log_context_storage::set(key, value);
    }

References kcenon::logger::log_context_storage::get_field(), had_previous_, previous_value_, and kcenon::logger::log_context_storage::set().

Here is the call graph for this function:

◆ scoped_context() [2/7]

kcenon::logger::scoped_context::scoped_context	(	const std::string &	key,
		int64_t	value )

inline

Construct with integer value.

Definition at line 365 of file log_context_scope.h.

        : key_(key), had_previous_(false) {
        auto prev = log_context_storage::get_field(key);
        if (prev) {
            had_previous_ = true;
            previous_value_ = *prev;
        }
        log_context_storage::set(key, value);
    }

References kcenon::logger::log_context_storage::get_field(), had_previous_, previous_value_, and kcenon::logger::log_context_storage::set().

Here is the call graph for this function:

◆ scoped_context() [3/7]

kcenon::logger::scoped_context::scoped_context	(	const std::string &	key,
		int	value )

inline

Construct with int value (converts to int64_t)

Definition at line 378 of file log_context_scope.h.

379 : scoped_context(key, static_cast<int64_t>(value)) {}

kcenon::logger::scoped_context::scoped_context

scoped_context(const std::string &key, const std::string &value)

Construct with string value.

Definition log_context_scope.h:352

◆ scoped_context() [4/7]

kcenon::logger::scoped_context::scoped_context	(	const std::string &	key,
		double	value )

inline

Construct with double value.

Definition at line 384 of file log_context_scope.h.

        : key_(key), had_previous_(false) {
        auto prev = log_context_storage::get_field(key);
        if (prev) {
            had_previous_ = true;
            previous_value_ = *prev;
        }
        log_context_storage::set(key, value);
    }

References kcenon::logger::log_context_storage::get_field(), had_previous_, previous_value_, and kcenon::logger::log_context_storage::set().

Here is the call graph for this function:

◆ scoped_context() [5/7]

kcenon::logger::scoped_context::scoped_context	(	const std::string &	key,
		bool	value )

inline

Construct with boolean value.

Definition at line 397 of file log_context_scope.h.

        : key_(key), had_previous_(false) {
        auto prev = log_context_storage::get_field(key);
        if (prev) {
            had_previous_ = true;
            previous_value_ = *prev;
        }
        log_context_storage::set(key, value);
    }

References kcenon::logger::log_context_storage::get_field(), had_previous_, previous_value_, and kcenon::logger::log_context_storage::set().

Here is the call graph for this function:

◆ ~scoped_context()

kcenon::logger::scoped_context::~scoped_context ( )

inline

Destructor - restores or removes the context field.

Examples: /home/runner/work/logger_system/logger_system/include/kcenon/logger/core/log_context_scope.h.

Definition at line 410 of file log_context_scope.h.

                      {
        if (had_previous_) {
            log_context_storage::set(key_, previous_value_);
        } else {
            log_context_storage::remove(key_);
        }
    }