settings

Contains global settings, which can be changed at runtime. More...

Functions
std::atomic_bool &	mimicpp::settings::report_success () noexcept
	Controls whether successful matches are reported.
std::atomic_size_t &	mimicpp::settings::stacktrace_base_skip () noexcept
	Controls whether the base stacktrace-skip value.

Detailed Description

Contains global settings, which can be changed at runtime.

Function Documentation

report_success()

std::atomic_bool & mimicpp::settings::report_success ( )

inlinenodiscardnoexcept

Controls whether successful matches are reported.

Reporting can be an expensive operation, particularly when stacktraces are collected. To reduce overhead, mimic++ reports only violations by default.

Note

This setting affects only the behavior of mimic++. When using a test adapter, additional configuration in the test framework may be required to receive such reports.

Returns

a mutable reference to the actual settings value.

Here is the caller graph for this function:

stacktrace_base_skip()

std::atomic_size_t & mimicpp::settings::stacktrace_base_skip ( )

inlinenodiscardnoexcept

Controls whether the base stacktrace-skip value.

This value will be added to all user-supplied skip values. This comes in handy when the current stacktrace backend captures more frames than other backends would usually do.

Returns

a mutable reference to the actual settings value.