CppSpec::Matchers::Contain< A, E, U > Class Template Reference

#include <contain.hpp>

Inheritance diagram for CppSpec::Matchers::Contain< A, E, U >:

Collaboration diagram for CppSpec::Matchers::Contain< A, E, U >:

Public Member Functions
bool	match () override
bool	negated_match () override
Public Member Functions inherited from CppSpec::Matchers::ContainBase< A, E, U >
std::string	verb () override
std::string	description () override
	Get the description of the Matcher.
std::string	failure_message () override
	Get message to give on match failure.
std::string	failure_message_when_negated () override
	Get message to give on match failure when negated.
virtual bool	diffable ()
	ContainBase (Expectation< A > &expectation, std::initializer_list< U > expected)
	ContainBase (Expectation< A > &expectation, U expected)
Public Member Functions inherited from CppSpec::Matchers::MatcherBase< A, E >
	MatcherBase (MatcherBase< A, E > const &copy)=default
	MatcherBase (Expectation< A > &expectation)
	MatcherBase (Expectation< A > &expectation, E expected)
constexpr A &	actual ()
E &	expected ()
Expectation< A > &	expectation ()
virtual MatcherBase &	set_message (std::string message)
	Set a custom failure message.
std::source_location	get_location () const
Result	run ()
	Run the Matcher object.
Public Member Functions inherited from CppSpec::Pretty
std::string	name (const std::string &name) const
std::string	name_to_sentence (const std::string &name) const
template<typename O>
std::string	inspect_object (const O &o)
	Generate a string of the class and data of an object.

Protected Member Functions
bool	perform_match (Predicate predicate, Predicate hash_subset_predicate)
Protected Member Functions inherited from CppSpec::Matchers::ContainBase< A, E, U >
bool	actual_collection_includes (U expected_item)

Additional Inherited Members
Public Types inherited from CppSpec::Matchers::MatcherBase< A, E >
using	expected_t
Static Public Member Functions inherited from CppSpec::Pretty
static std::string	split_words (const std::string &sym)
static std::string	underscore (const std::string &camel_cased_word)
static std::string	last (const std::string &s, char delim)
static std::string	improve_hash_formatting (const std::string &inspect_string)
template<Util::is_streamable T>
static std::string	to_word (const T &item)
	Formats an object as a string when operator<< is available.
template<typename T>
static std::string	to_word (const T &item)
template<typename T>
static std::string	to_word_type (const T &item)
template<typename A, typename E>
static std::string	to_word (const Matchers::MatcherBase< A, E > &matcher)
template<class T>
static std::string	to_sentence (const T &item)
	Take a single object and format it as a sentance.
template<class T>
static std::string	to_sentence (const std::vector< T > &words)
template<typename T>
static std::string	inspect_object (const T &object)
template<>
std::string	to_word (const bool &item)
template<>
std::string	inspect_object (const char *const &o)
	Specialization for C-style strings.
Public Attributes inherited from CppSpec::Pretty
std::string	_name
Protected Attributes inherited from CppSpec::Matchers::MatcherBase< A, E >
E	expected_
Expectation< A > &	expectation_

Detailed Description

template<typename A, typename E, typename U>
class CppSpec::Matchers::Contain< A, E, U >

The template specialization of Include that permits matching against a list of elements (i.e. expected({1,2,3,4}).to_include({1,4}) )

Member Function Documentation

match()

template<typename A, typename E, typename U>

bool CppSpec::Matchers::Contain< A, E, U >::match ( )

overridevirtual

Implements CppSpec::Matchers::MatcherBase< A, E >.

negated_match()

template<typename A, typename E, typename U>

bool CppSpec::Matchers::Contain< A, E, U >::negated_match ( )

overridevirtual

Reimplemented from CppSpec::Matchers::MatcherBase< A, E >.

---

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

• include/matchers/contain.hpp