CppSpec::Matchers::Equal< A, E > Class Template Reference

The equal matcher. More...

#include <equal.hpp>

Inheritance diagram for CppSpec::Matchers::Equal< A, E >:

Collaboration diagram for CppSpec::Matchers::Equal< A, E >:

Public Member Functions
	Equal (Expectation< A > &expectation, E expected)
std::string	verb () override
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.
bool	diffable ()
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)
virtual std::string	description ()
	Get the description of the Matcher.
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.
virtual bool	negated_match ()
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	match () override
bool	expected_is_a_literal ()
std::string	actual_inspected ()
std::string	simple_failure_message ()

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>
class CppSpec::Matchers::Equal< A, E >

The equal matcher.

Template Parameters

A	the type of the actual value
E	the type of the expected value

Member Function Documentation

failure_message()

template<typename A, typename E>

std::string CppSpec::Matchers::Equal< A, E >::failure_message ( )

overridevirtual

Get message to give on match failure.

Returns

the message

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

failure_message_when_negated()

template<typename A, typename E>

std::string CppSpec::Matchers::Equal< A, E >::failure_message_when_negated ( )

overridevirtual

Get message to give on match failure when negated.

Returns

the message

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

match()

template<typename A, typename E>

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

overrideprotectedvirtual

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

verb()

template<typename A, typename E>

std::string CppSpec::Matchers::Equal< A, E >::verb ( )

inlineoverridevirtual

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

---

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

• include/matchers/equal.hpp