The collection_valid class contains a collection of static methods that implement the most collection assertions used in tUnit. More...

#include <collection_valid.h>

Inheritance diagram for tunit::collection_valid:

[legend]

Collaboration diagram for tunit::collection_valid:

[legend]

Static Public Member Functions
template<typename TExpected , typename TCollection >
static void	all_items_are_instances_of (const TCollection &collection)
	Valids that all collection items are of the type supplied or a derived type. More...

template<typename TExpected , typename TCollection >
static void	all_items_are_instances_of (const TCollection &collection, const std::string &message)
	Valids that all collection items are of the type supplied or a derived type. More...

template<typename TExpected , typename TCollection >
static void	all_items_are_instances_of (const TCollection &collection, const tunit::line_info &line_info)
	Valids that all collection items are of the type supplied or a derived type. More...

template<typename TExpected , typename TCollection >
static void	all_items_are_instances_of (const TCollection &collection, const std::string &message, const tunit::line_info &line_info)
	Valids that all collection items are of the type supplied or a derived type. More...

template<typename TCollection >
static void	all_items_are_not_null (const TCollection &collection)
	Valids that all collection items are not null. More...

template<typename TCollection >
static void	all_items_are_not_null (const TCollection &collection, const std::string &message)
	Valids that all collection items are not null. More...

template<typename TCollection >
static void	all_items_are_not_null (const TCollection &collection, const tunit::line_info &line_info)
	Valids that all collection items are not null. More...

template<typename TCollection >
static void	all_items_are_not_null (const TCollection &collection, const std::string &message, const tunit::line_info &line_info)
	Valids that all collection items are not null. More...

template<typename TCollection >
static void	all_items_are_unique (const TCollection &collection)
	Valids that all collection items are unique. More...

template<typename TCollection >
static void	all_items_are_unique (const TCollection &collection, const std::string &message)
	Valids that all collection items are unique. More...

template<typename TCollection >
static void	all_items_are_unique (const TCollection &collection, const tunit::line_info &line_info)
	Valids that all collection items are unique. More...

template<typename TCollection >
static void	all_items_are_unique (const TCollection &collection, const std::string &message, const tunit::line_info &line_info)
	Valids that all collection items are unique. More...

template<typename TExpected , typename TAcutal >
static void	are_equal (const TExpected &expected, const TAcutal &actual)
	Valids that all collection items are equal. More...

template<typename TExpected , typename TAcutal >
static void	are_equal (const TExpected &expected, const TAcutal &actual, const std::string &message)
	Valids that all collection items are equal. More...

template<typename TExpected , typename TAcutal >
static void	are_equal (const TExpected &expected, const TAcutal &actual, const tunit::line_info &line_info)
	Valids that all collection items are equal. More...

template<typename TExpected , typename TAcutal >
static void	are_equal (const TExpected &expected, const TAcutal &actual, const std::string &message, const tunit::line_info &line_info)
	Valids that all collection items are equal. More...

template<typename TExpected , typename TAcutal >
static void	are_equivalent (const TExpected &expected, const TAcutal &actual)
	Valids that all collection items are equivalent. More...

template<typename TExpected , typename TAcutal >
static void	are_equivalent (const TExpected &expected, const TAcutal &actual, const std::string &message)
	Valids that all collection items are equivalent. More...

template<typename TExpected , typename TAcutal >
static void	are_equivalent (const TExpected &expected, const TAcutal &actual, const tunit::line_info &line_info)
	Valids that all collection items are equivalent. More...

template<typename TExpected , typename TAcutal >
static void	are_equivalent (const TExpected &expected, const TAcutal &actual, const std::string &message, const tunit::line_info &line_info)
	Valids that all collection items are equivalent. More...

template<typename TExpected , typename TAcutal >
static void	are_not_equal (const TExpected &expected, const TAcutal &actual)
	Valids that all collection items are not equal. More...

template<typename TExpected , typename TAcutal >
static void	are_not_equal (const TExpected &expected, const TAcutal &actual, const std::string &message)
	Valids that all collection items are not equal. More...

template<typename TExpected , typename TAcutal >
static void	are_not_equal (const TExpected &expected, const TAcutal &actual, const tunit::line_info &line_info)
	Valids that all collection items are not equal. More...

template<typename TExpected , typename TAcutal >
static void	are_not_equal (const TExpected &expected, const TAcutal &actual, const std::string &message, const tunit::line_info &line_info)
	Valids that all collection items arenot equal. More...

template<typename TExpected , typename TAcutal >
static void	are_not_equivalent (const TExpected &expected, const TAcutal &actual)
	Valids that all collection items are not equivalent. More...

template<typename TExpected , typename TAcutal >
static void	are_not_equivalent (const TExpected &expected, const TAcutal &actual, const std::string &message)
	Valids that all collection items are not equivalent. More...

template<typename TExpected , typename TAcutal >
static void	are_not_equivalent (const TExpected &expected, const TAcutal &actual, const tunit::line_info &line_info)
	Valids that all collection items are not equivalent. More...

template<typename TExpected , typename TAcutal >
static void	are_not_equivalent (const TExpected &expected, const TAcutal &actual, const std::string &message, const tunit::line_info &line_info)
	Valids that all collection items are not equivalent. More...

template<typename TExpected , typename TAcutal >
static void	contains (const TExpected &expected, const TAcutal &actual)
	Valids that ollection contains all items. More...

template<typename TExpected , typename TAcutal >
static void	contains (const TExpected &expected, const TAcutal &actual, const std::string &message)
	Valids that collection contains all items. More...

template<typename TExpected , typename TAcutal >
static void	contains (const TExpected &expected, const TAcutal &actual, const tunit::line_info &line_info)
	Valids that collection contains all items. More...

template<typename TExpected , typename TAcutal >
static void	contains (const TExpected &expected, const TAcutal &actual, const std::string &message, const tunit::line_info &line_info)
	Valids that collection contains all items. More...

template<typename TExpected , typename TAcutal >
static void	does_not_contain (const TExpected &expected, const TAcutal &actual)
	Valids that ollection contains all items. More...

template<typename TExpected , typename TAcutal >
static void	does_not_contain (const TExpected &expected, const TAcutal &actual, const std::string &message)
	Valids that collection contains all items. More...

template<typename TExpected , typename TAcutal >
static void	does_not_contain (const TExpected &expected, const TAcutal &actual, const tunit::line_info &line_info)
	Valids that collection contains all items. More...

template<typename TExpected , typename TAcutal >
static void	does_not_contain (const TExpected &expected, const TAcutal &actual, const std::string &message, const tunit::line_info &line_info)
	Valids that collection contains all items. More...

template<typename TValue >
static void	is_empty (const TValue &value)
	Valids that collection contains an item. More...

template<typename TValue >
static void	is_empty (const TValue &value, const tunit::line_info &line_info)
	Valids that collection contains an item. More...

template<typename TValue >
static void	is_empty (const TValue &value, const std::string &message)
	Valids that collection contains an item. More...

template<typename TValue >
static void	is_empty (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Valids that collection contains an item. More...

template<typename TValue >
static void	is_not_empty (const TValue &value)
	Valids that collection does not contain any item. More...

template<typename TValue >
static void	is_not_empty (const TValue &value, const tunit::line_info &line_info)
	Valids that collection or traits does not contain any item. More...

template<typename TValue >
static void	is_not_empty (const TValue &value, const std::string &message)
	Valids that collection or traits does not contain any item. More...

template<typename TValue >
static void	is_not_empty (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Valids that collection or traits does not contain any item. More...

template<typename TValue >
static void	is_ordered (const TValue &value)
	Valids that collection is ordered. More...

template<typename TValue >
static void	is_ordered (const TValue &value, const tunit::line_info &line_info)
	Valids that collection is ordered. More...

template<typename TValue >
static void	is_ordered (const TValue &value, const std::string &message)
	Valids that collection is ordered. More...

template<typename TValue >
static void	is_ordered (const TValue &value, const std::string &message, const tunit::line_info &line_info)
	Valids that collection is ordered. More...

Static Private Member Functions
static void	abort ()
	Abort current test. More...

static void	abort (const tunit::line_info &line_info)
	Abort current test. More...

static void	abort (const std::string &message)
	Abort current test. More...

static void	abort (const std::string &message, const tunit::line_info &line_info)
	Abort current test. More...

static void	error ()

static void	error (const std::string &actual, const std::string &expected, const std::string &message, const tunit::line_info &line_info)

static void	fail ()
	Throws an tunit::assertion_error exception. More...

static void	fail (const tunit::line_info &line_info)
	Throws an tunit::assertion_error exception. More...

static void	fail (const std::string &message)
	Throws an tunit::assertion_error exception. More...

static void	fail (const std::string &message, const tunit::line_info &line_info)
	Throws an tunit::assertion_error exception. More...

static void	fail (const std::string &actual, const std::string &expected, const std::string &message, const tunit::line_info &line_info)

static void	ignore ()
	Ignore current test. More...

static void	ignore (const tunit::line_info &line_info)
	Ignore current test. More...

static void	ignore (const std::string &message)
	Ignore current test. More...

static void	ignore (const std::string &message, const tunit::line_info &line_info)
	Ignore current test. More...

template<typename TCollection >
static std::string	join_items (const TCollection &collection)

static std::string	join_items (const std::string &str)

static void	succeed ()
	Generates a success with a generic message. More...

static void	succeed (const tunit::line_info &line_info)
	Generates a success with a generic message. More...

static void	succeed (const std::string &message)
	Generates a success with a generic message. More...

static void	succeed (const std::string &message, const tunit::line_info &line_info)
	Generates a success with a generic message. More...

template<typename TValue >
static std::string	to_string (const TValue &value)

template<typename TValue >
static std::string	to_string (const TValue *value)

Detailed Description

The collection_valid class contains a collection of static methods that implement the most collection assertions used in tUnit.

Examples: This example show how to used some methods :

Member Function Documentation

◆ all_items_are_instances_of() [1/4]

template<typename TExpected , typename TCollection >

static void tunit::collection_valid::all_items_are_instances_of ( const TCollection & collection )

inlinestatic

Valids that all collection items are of the type supplied or a derived type.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<std::ios_base*> a = {&std::cout, &std::cerr, &std::cin};
tunit::collection_valid::all_items_are_instances_of<std::ios_base*>(a); // test ok.
tunit::collection_valid::all_items_are_instances_of<std::basic_ostream<char>*>(a); // test fails.

◆ all_items_are_instances_of() [2/4]

template<typename TExpected , typename TCollection >

static void tunit::collection_valid::all_items_are_instances_of	(	const TCollection &	collection,
		const std::string &	message
	)

inlinestatic

Valids that all collection items are of the type supplied or a derived type.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<std::ios_base*> a = {&std::cout, &std::cerr, &std::cin};
tunit::collection_valid::all_items_are_instances_of<std::ios_base*>(a, "User message..."); // test ok.
tunit::collection_valid::all_items_are_instances_of<std::basic_ostream<char>*>(a, "User message..."); // test fails.

◆ all_items_are_instances_of() [3/4]

template<typename TExpected , typename TCollection >

static void tunit::collection_valid::all_items_are_instances_of	(	const TCollection &	collection,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are of the type supplied or a derived type.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<std::ios_base*> a = {&std::cout, &std::cerr, &std::cin};
tunit::collection_valid::all_items_are_instances_of<std::ios_base*>(a, line_info_); // test ok.
tunit::collection_valid::all_items_are_instances_of<std::basic_ostream<char>*>(a, line_info_); // test fails.

◆ all_items_are_instances_of() [4/4]

template<typename TExpected , typename TCollection >

static void tunit::collection_valid::all_items_are_instances_of	(	const TCollection &	collection,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are of the type supplied or a derived type.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<std::ios_base*> a = {&std::cout, &std::cerr, &std::cin};
tunit::collection_valid::all_items_are_instances_of<std::ios_base*>(a, "User message...", line_info_); // test ok.
tunit::collection_valid::all_items_are_instances_of<std::basic_ostream<char>*>(a, "User message...", line_info_); // test fails.

◆ all_items_are_not_null() [1/4]

template<typename TCollection >

static void tunit::collection_valid::all_items_are_not_null ( const TCollection & collection )

inlinestatic

Valids that all collection items are not null.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: int i1 = 0, i2 = 3;
std::vector<int*> a1 = {&i1, &i2};
tunit::collection_valid::all_items_are_not_null(a1); // test ok.
std::vector<int*> a2 = {&i1, &i2, nullptr};
tunit::collection_valid::all_items_are_not_null(a2); // test fails.

◆ all_items_are_not_null() [2/4]

template<typename TCollection >

static void tunit::collection_valid::all_items_are_not_null	(	const TCollection &	collection,
		const std::string &	message
	)

inlinestatic

Valids that all collection items are not null.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: int i1 = 0, i2 = 3;
std::vector<int*> a1 = {&i1, &i2};
tunit::collection_valid::all_items_are_not_null(a1, "User message..."); // test ok.
std::vector<int*> a2 = {&i1, &i2, nullptr};
tunit::collection_valid::all_items_are_not_null(a2, "User message..."); // test fails.

◆ all_items_are_not_null() [3/4]

template<typename TCollection >

static void tunit::collection_valid::all_items_are_not_null	(	const TCollection &	collection,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are not null.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: int i1 = 0, i2 = 3;
std::vector<int*> a1 = {&i1, &i2};
tunit::collection_valid::all_items_are_not_null(a1, line_info_); // test ok.
std::vector<int*> a2 = {&i1, &i2, nullptr};
tunit::collection_valid::all_items_are_not_null(a2, line_info_); // test fails.

◆ all_items_are_not_null() [4/4]

template<typename TCollection >

static void tunit::collection_valid::all_items_are_not_null	(	const TCollection &	collection,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are not null.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: int i1 = 0, i2 = 3;
std::vector<int*> a1 = {&i1, &i2};
tunit::collection_valid::all_items_are_not_null(a1, "User message...", line_info_); // test ok.
std::vector<int*> a2 = {&i1, &i2, nullptr};
tunit::collection_valid::all_items_are_not_null(a2, "User message...", line_info_); // test fails.

◆ all_items_are_unique() [1/4]

template<typename TCollection >

static void tunit::collection_valid::all_items_are_unique ( const TCollection & collection )

inlinestatic

Valids that all collection items are unique.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a1 = {1, 2, 3, 4};
tunit::collection_valid::all_items_are_unique(a1); // test ok.
std::vector<int> a2 = {1, 2, 3, 4, 1};
tunit::collection_valid::all_items_are_unique(a2); // test fails.

◆ all_items_are_unique() [2/4]

template<typename TCollection >

static void tunit::collection_valid::all_items_are_unique	(	const TCollection &	collection,
		const std::string &	message
	)

inlinestatic

Valids that all collection items are unique.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a1 = {1, 2, 3, 4};
tunit::collection_valid::all_items_are_unique(a1, "User message..."); // test ok.
std::vector<int> a2 = {1, 2, 3, 4, 1};
tunit::collection_valid::all_items_are_unique(a2, "User message..."); // test fails.

◆ all_items_are_unique() [3/4]

template<typename TCollection >

static void tunit::collection_valid::all_items_are_unique	(	const TCollection &	collection,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are unique.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a1 = {1, 2, 3, 4};
tunit::collection_valid::all_iall_items_are_uniquetems_are_not_null(a1, line_info_); // test ok.
std::vector<int> a2 = {1, 2, 3, 4, 1};
tunit::collection_valid::all_items_are_unique(a2, line_info_); // test fails.

◆ all_items_are_unique() [4/4]

template<typename TCollection >

static void tunit::collection_valid::all_items_are_unique	(	const TCollection &	collection,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are unique.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a1 = {1, 2, 3, 4};
tunit::collection_valid::all_items_are_unique(a1, "User message...", line_info_); // test ok.
std::vector<int> a2 = {1, 2, 3, 4, 1};
tunit::collection_valid::all_items_are_unique(a2, "User message...", line_info_); // test fails.

◆ are_equal() [1/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_equal	(	const TExpected &	expected,
		const TAcutal &	actual
	)

inlinestatic

Valids that all collection items are equal.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_equal({1, 2, 3, 4}, a); // test ok.
tunit::collection_valid::are_equal({4, 3, 2, 1}, a); // test fails.

◆ are_equal() [2/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_equal	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message
	)

inlinestatic

Valids that all collection items are equal.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_equal({1, 2, 3, 4}, a, "User message..."); // test ok.
tunit::collection_valid::are_equal({4, 3, 2, 1}, a, "User message..."); // test fails.

◆ are_equal() [3/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_equal	(	const TExpected &	expected,
		const TAcutal &	actual,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are equal.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_equal({1, 2, 3, 4}, a, line_info_); // test ok.
tunit::collection_valid::are_equal({4, 3, 2, 1}, a, line_info_); // test fails.

◆ are_equal() [4/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_equal	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are equal.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_equal({1, 2, 3, 4}, a, "User message...", line_info_); // test ok.
tunit::collection_valid::are_equal({4, 3, 2, 1}, a, "User message...", line_info_); // test fails.

◆ are_equivalent() [1/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_equivalent	(	const TExpected &	expected,
		const TAcutal &	actual
	)

inlinestatic

Valids that all collection items are equivalent.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_equivalent({4, 3, 2, 1}, a); // test ok.
tunit::collection_valid::are_equivalent({1, 2, 3, 5}, a); // test fails.

◆ are_equivalent() [2/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_equivalent	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message
	)

inlinestatic

Valids that all collection items are equivalent.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_equivalent({4, 3, 2, 1}, a, "User message..."); // test ok.
tunit::collection_valid::are_equivalent({1, 2, 3, 5}, a, "User message..."); // test fails.

◆ are_equivalent() [3/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_equivalent	(	const TExpected &	expected,
		const TAcutal &	actual,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are equivalent.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_equivalent({4, 3, 2, 1}, a, line_info_); // test ok.
tunit::collection_valid::are_equivalent({1, 2, 3, 5}, a, line_info_); // test fails.

◆ are_equivalent() [4/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_equivalent	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are equivalent.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_equivalent({4, 3, 2, 1}, a, "User message...", line_info_); // test ok.
tunit::collection_valid::are_equivalent({1, 2, 3, 5}, a, "User message...", line_info_); // test fails.

◆ are_not_equal() [1/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_not_equal	(	const TExpected &	expected,
		const TAcutal &	actual
	)

inlinestatic

Valids that all collection items are not equal.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_not_equal({4, 3, 2, 1}, a); // test ok.
tunit::collection_valid::are_not_equal({1, 2, 3, 4}, a); // test fails.

◆ are_not_equal() [2/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_not_equal	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message
	)

inlinestatic

Valids that all collection items are not equal.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_not_equal({4, 3, 2, 1}, a, "User message..."); // test ok.
tunit::collection_valid::are_not_equal({1, 2, 3, 4}, a, "User message..."); // test fails.

◆ are_not_equal() [3/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_not_equal	(	const TExpected &	expected,
		const TAcutal &	actual,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are not equal.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_not_equal({4, 3, 2, 1}, a, line_info_); // test ok.
tunit::collection_valid::are_not_equal({1, 2, 3, 4}, a, line_info_); // test fails.

◆ are_not_equal() [4/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_not_equal	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items arenot equal.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_not_equal({4, 3, 2, 1}, a, "User message...", line_info_); // test ok.
tunit::collection_valid::are_not_equal({1, 2, 3, 4}, a, "User message...", line_info_); // test fails.

◆ are_not_equivalent() [1/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_not_equivalent	(	const TExpected &	expected,
		const TAcutal &	actual
	)

inlinestatic

Valids that all collection items are not equivalent.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_not_equivalent({1, 2, 3, 5}, a); // test ok.
tunit::collection_valid::are_not_equivalent({4, 3, 2, 1}, a); // test fails.

◆ are_not_equivalent() [2/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_not_equivalent	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message
	)

inlinestatic

Valids that all collection items are not equivalent.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_not_equivalent({1, 2, 3, 5}, a, "User message..."); // test ok.
tunit::collection_valid::are_not_equivalent({4, 3, 2, 1}, a, "User message..."); // test fails.

◆ are_not_equivalent() [3/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_not_equivalent	(	const TExpected &	expected,
		const TAcutal &	actual,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are not equivalent.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_not_equivalent({1, 2, 3, 5}, a, line_info_); // test ok.
tunit::collection_valid::are_not_equivalent({4, 3, 2, 1}, a, line_info_); // test fails.

◆ are_not_equivalent() [4/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::are_not_equivalent	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that all collection items are not equivalent.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::are_not_equivalent({1, 2, 3, 5}, a, "User message...", line_info_); // test ok.
tunit::collection_valid::are_not_equivalent({4, 3, 2, 1}, a, "User message...", line_info_); // test fails.

◆ contains() [1/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::contains	(	const TExpected &	expected,
		const TAcutal &	actual
	)

inlinestatic

Valids that ollection contains all items.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::contains({1, 2, a); // test ok.
tunit::collection_valid::contains({1, 2, 6}, a); // test fails.

◆ contains() [2/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::contains	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message
	)

inlinestatic

Valids that collection contains all items.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::contains({1, 2}, a, "User message..."); // test ok.
tunit::collection_valid::contains({1, 2, 6}, a, "User message..."); // test fails.

◆ contains() [3/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::contains	(	const TExpected &	expected,
		const TAcutal &	actual,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that collection contains all items.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::contains({1, 2}, a, line_info_); // test ok.
tunit::collection_valid::contains({1, 2, 6}, a, line_info_); // test fails.

◆ contains() [4/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::contains	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that collection contains all items.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::contains({1, 2}, a, "User message...", line_info_); // test ok.
tunit::collection_valid::contains({1, 2, 6}, a, "User message...", line_info_); // test fails.

◆ does_not_contain() [1/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::does_not_contain	(	const TExpected &	expected,
		const TAcutal &	actual
	)

inlinestatic

Valids that ollection contains all items.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::does_not_contain({1, 2, a); // test ok.
tunit::collection_valid::does_not_contain({1, 2, 6}, a); // test fails.

◆ does_not_contain() [2/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::does_not_contain	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message
	)

inlinestatic

Valids that collection contains all items.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::does_not_contain({1, 2}, a, "User message..."); // test ok.
tunit::collection_valid::does_not_contain({1, 2, 6}, a, "User message..."); // test fails.

◆ does_not_contain() [3/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::does_not_contain	(	const TExpected &	expected,
		const TAcutal &	actual,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that collection contains all items.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::does_not_contain({1, 2}, a, line_info_); // test ok.
tunit::collection_valid::does_not_contain({1, 2, 6}, a, line_info_); // test fails.

◆ does_not_contain() [4/4]

template<typename TExpected , typename TAcutal >

static void tunit::collection_valid::does_not_contain	(	const TExpected &	expected,
		const TAcutal &	actual,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that collection contains all items.

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> a = {1, 2, 3, 4};
tunit::collection_valid::does_not_contain({1, 2}, a, "User message...", line_info_); // test ok.
tunit::collection_valid::does_not_contain({1, 2, 6}, a, "User message...", line_info_); // test fails.

◆ is_empty() [1/4]

template<typename TValue >

static void tunit::collection_valid::is_empty ( const TValue & value )

inlinestatic

Valids that collection contains an item.

Parameters

value The value to check is empty.

Examples: std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
tunit::assert::is_empty(v1); // test ok.
tunit::assert::is_empty(v2); // test fails

◆ is_empty() [2/4]

template<typename TValue >

static void tunit::collection_valid::is_empty	(	const TValue &	value,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that collection contains an item.

Parameters

value	The value to check is empty.
line_info	Contains information about current file and current line.

Examples: std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
tunit::assert::is_empty(v1, line_info_); // test ok.
tunit::assert::is_empty(v2, line_info_); // test fails

◆ is_empty() [3/4]

template<typename TValue >

static void tunit::collection_valid::is_empty	(	const TValue &	value,
		const std::string &	message
	)

inlinestatic

Valids that collection contains an item.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Examples: std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
tunit::assert::is_empty(v1, "User message..."); // test ok.
tunit::assert::is_empty(v2, "User message..."); // test fails

◆ is_empty() [4/4]

template<typename TValue >

static void tunit::collection_valid::is_empty	(	const TValue &	value,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that collection contains an item.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
tunit::assert::is_empty(v1, "User message...", line_info_); // test ok.
tunit::assert::is_empty(v2, "User message...", line_info_); // test fails

◆ is_not_empty() [1/4]

template<typename TValue >

static void tunit::collection_valid::is_not_empty ( const TValue & value )

inlinestatic

Valids that collection does not contain any item.

Parameters

value The value to check is empty.

Examples: std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
tunit::assert::is_not_empty(v1); // test ok.
tunit::assert::is_not_empty(v2); // test fails

◆ is_not_empty() [2/4]

template<typename TValue >

static void tunit::collection_valid::is_not_empty	(	const TValue &	value,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that collection or traits does not contain any item.

Parameters

value	The value to check is empty.
line_info	Contains information about current file and current line.

Examples: std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
tunit::assert::is_not_empty(v1, line_info_); // test ok.
tunit::assert::is_not_empty(v2, line_info_); // test fails

◆ is_not_empty() [3/4]

template<typename TValue >

static void tunit::collection_valid::is_not_empty	(	const TValue &	value,
		const std::string &	message
	)

inlinestatic

Valids that collection or traits does not contain any item.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Examples: std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
tunit::assert::is_not_empty(v1, "User message..."); // test ok.
tunit::assert::is_not_empty(v2, "User message..."); // test fails

◆ is_not_empty() [4/4]

template<typename TValue >

static void tunit::collection_valid::is_not_empty	(	const TValue &	value,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that collection or traits does not contain any item.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
tunit::assert::is_not_empty(v1, "User message...", line_info_); // test ok.
tunit::assert::is_not_empty(v2, "User message...", line_info_); // test fails

◆ is_ordered() [1/4]

template<typename TValue >

static void tunit::collection_valid::is_ordered ( const TValue & value )

inlinestatic

Valids that collection is ordered.

Parameters

value The value to check is empty.

Examples: std::vector<int> v1 = {1, 2, 3, 4};
std::vector<int> v2 = {1, 2, 4, 3};
tunit::assert::is_ordered(v1); // test ok.
tunit::assert::is_ordered(v2); // test fails

◆ is_ordered() [2/4]

template<typename TValue >

static void tunit::collection_valid::is_ordered	(	const TValue &	value,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that collection is ordered.

Parameters

value	The value to check is empty.
line_info	Contains information about current file and current line.

Examples: std::vector<int> v1 = {1, 2, 3, 4};
std::vector<int> v2 = {1, 2, 4, 3};
tunit::assert::is_ordered(v1, line_info_); // test ok.
tunit::assert::is_ordered(v2, line_info_); // test fails

◆ is_ordered() [3/4]

template<typename TValue >

static void tunit::collection_valid::is_ordered	(	const TValue &	value,
		const std::string &	message
	)

inlinestatic

Valids that collection is ordered.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Examples: std::vector<int> v1 = {1, 2, 3, 4};
std::vector<int> v2 = {1, 2, 4, 3};
tunit::assert::is_ordered(v1, "User message..."); // test ok.
tunit::assert::is_ordered(v2, "User message..."); // test fails

◆ is_ordered() [4/4]

template<typename TValue >

static void tunit::collection_valid::is_ordered	(	const TValue &	value,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that collection is ordered.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
line_info	Contains information about current file and current line.

Examples: std::vector<int> v1 = {1, 2, 3, 4};
std::vector<int> v2 = {1, 2, 4, 3};
tunit::assert::is_ordered(v1, "User message...", line_info_); // test ok.
tunit::assert::is_ordered(v2, "User message...", line_info_); // test fails

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

collection_valid.h

Static Public Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ all_items_are_instances_of() [1/4]

◆ all_items_are_instances_of() [2/4]

◆ all_items_are_instances_of() [3/4]

◆ all_items_are_instances_of() [4/4]

◆ all_items_are_not_null() [1/4]

◆ all_items_are_not_null() [2/4]

◆ all_items_are_not_null() [3/4]

◆ all_items_are_not_null() [4/4]

◆ all_items_are_unique() [1/4]

◆ all_items_are_unique() [2/4]

◆ all_items_are_unique() [3/4]

◆ all_items_are_unique() [4/4]

◆ are_equal() [1/4]

◆ are_equal() [2/4]

◆ are_equal() [3/4]

◆ are_equal() [4/4]

◆ are_equivalent() [1/4]

◆ are_equivalent() [2/4]

◆ are_equivalent() [3/4]

◆ are_equivalent() [4/4]

◆ are_not_equal() [1/4]

◆ are_not_equal() [2/4]

◆ are_not_equal() [3/4]

◆ are_not_equal() [4/4]

◆ are_not_equivalent() [1/4]

◆ are_not_equivalent() [2/4]

◆ are_not_equivalent() [3/4]

◆ are_not_equivalent() [4/4]

◆ contains() [1/4]

◆ contains() [2/4]

◆ contains() [3/4]

◆ contains() [4/4]

◆ does_not_contain() [1/4]

◆ does_not_contain() [2/4]

◆ does_not_contain() [3/4]

◆ does_not_contain() [4/4]

◆ is_empty() [1/4]

◆ is_empty() [2/4]

◆ is_empty() [3/4]

◆ is_empty() [4/4]

◆ is_not_empty() [1/4]

◆ is_not_empty() [2/4]

◆ is_not_empty() [3/4]

◆ is_not_empty() [4/4]

◆ is_ordered() [1/4]

◆ is_ordered() [2/4]

◆ is_ordered() [3/4]

◆ is_ordered() [4/4]