check-result.h File Reference

C++ header file with declarations for the µTest++ check result. More...

#include "expression-formatter.h"
#include "extension.h"
#include "reflection.h"
#include <cstdio>
#include <string>
#include "inlines/check-result-inlines.h"

Go to the source code of this file.

Classes
class	micro_os_plus::micro_test_plus::detail::check_result
	The result of one check, reported when destroyed. More...
struct	micro_os_plus::micro_test_plus::detail::failure_info
	The details of a check, displayed when it fails. More...

Namespaces
namespace	micro_os_plus
	The primary namespace for the µOS++ framework.
namespace	micro_os_plus::micro_test_plus
	Primary namespace for the µTest++ testing framework.
namespace	micro_os_plus::micro_test_plus::detail
	Internal implementation details for the µTest++ framework.

Enumerations
enum class	micro_os_plus::micro_test_plus::detail::check_kind {   micro_os_plus::micro_test_plus::detail::expectation ,   micro_os_plus::micro_test_plus::detail::requirement }
	The kind of a check, which determines what happens when it fails. More...

Detailed Description

This header provides the check_result class, the object returned by expect() and require(), together with the check_kind enumeration and the failure_info structure, passed to the reporter. The check result captures the result of one check and reports the outcome only when it is destroyed (i.e. at the semicolon following the expression statement), after the optional user message was appended via operator<<.

It also defines failed_requirement, the exception thrown to stop a test case after a failed require().

All live in the detail namespace and are not part of the public API.

This file is included by micro-os-plus/micro-test-plus.h, which is the header that the applications include.

Definition in file check-result.h.