mimicpp::ScopedExpectation Class Reference

Takes the ownership of an expectation and check whether it's satisfied during destruction. More...

#include <Expectation.hpp>

Collaboration diagram for mimicpp::ScopedExpectation:

Public Member Functions
	~ScopedExpectation () noexcept(false)
	Removes the owned expectation from the ExpectationCollection and checks, whether it's satisfied.
template<typename Signature>
	ScopedExpectation (std::shared_ptr< ExpectationCollection< Signature > > collection, std::shared_ptr< typename ExpectationCollection< Signature >::ExpectationT > expectation) noexcept
	Constructor, which generates the type-erase storage.
template<typename T> requires requires(util::SourceLocation loc) { { std::declval<T&&>().finalize(loc) } -> std::convertible_to<ScopedExpectation>; }
	explicit (false) const expr ScopedExpectation(T &&object
	A constructor, which accepts objects, which can be finalized (e.g. ExpectationBuilder).
ScopedExpectation &	operator= (ScopedExpectation const &)=delete
	Deleted copy-assignment-operator.
	ScopedExpectation (ScopedExpectation &&)=default
	Defaulted move-constructor.
ScopedExpectation &	operator= (ScopedExpectation &&)=default
	Defaulted move-assignment-operator.
bool	is_satisfied () const
	Queries the stored expectation, whether it's satisfied.
bool	is_applicable () const
	Queries the stored expectation, whether it's applicable.
util::SourceLocation const &	from () const noexcept
	Queries the stored expectation for it's stored source-location.
StringT const &	mock_name () const noexcept
	Queries the stored expectation for the name of the related mock.

Public Attributes
util::SourceLocation	loc

Detailed Description

Takes the ownership of an expectation and check whether it's satisfied during destruction.

The owned Expectation is type-erased. This comes in handy, when users want to store ScopedExpectations in a single container.

Constructor & Destructor Documentation

~ScopedExpectation()

mimicpp::ScopedExpectation::~ScopedExpectation ( )

inline

Removes the owned expectation from the ExpectationCollection and checks, whether it's satisfied.

Exceptions

In	cases of an unsatisfied expectation, the destructor is expected to throw or terminate otherwise.

ScopedExpectation() [1/2]

template<typename Signature>

mimicpp::ScopedExpectation::ScopedExpectation ( std::shared_ptr< ExpectationCollection< Signature > > collection, std::shared_ptr< typename ExpectationCollection< Signature >::ExpectationT > expectation )

inlineexplicitnodiscardnoexcept

Constructor, which generates the type-erase storage.

Template Parameters

Signature

The signature.

Parameters

collection	The expectation collection, the expectation will be attached to.
expectation	The expectation.

Here is the caller graph for this function:

ScopedExpectation() [2/2]

mimicpp::ScopedExpectation::ScopedExpectation ( ScopedExpectation && )

nodiscarddefault

Defaulted move-constructor.

Here is the call graph for this function:

Member Function Documentation

explicit()

template<typename T>
requires requires(util::SourceLocation loc) { { std::declval<T&&>().finalize(loc) } -> std::convertible_to<ScopedExpectation>; }

mimicpp::ScopedExpectation::explicit ( false ) const &&

nodiscard

A constructor, which accepts objects, which can be finalized (e.g. ExpectationBuilder).

Template Parameters

T	The object type.

Parameters

object	The object to be finalized.
loc	The source-location.

Here is the call graph for this function:

from()

util::SourceLocation const & mimicpp::ScopedExpectation::from ( ) const

inlinenodiscardnoexcept

Queries the stored expectation for it's stored source-location.

Returns

The stored source-location.

is_applicable()

bool mimicpp::ScopedExpectation::is_applicable ( ) const

inlinenodiscard

Queries the stored expectation, whether it's applicable.

Returns

True, if applicable.

is_satisfied()

bool mimicpp::ScopedExpectation::is_satisfied ( ) const

inlinenodiscard

Queries the stored expectation, whether it's satisfied.

Returns

True, if satisfied.

mock_name()

StringT const & mimicpp::ScopedExpectation::mock_name ( ) const

inlinenodiscardnoexcept

Queries the stored expectation for the name of the related mock.

Returns

The stored mock-name.

operator=() [1/2]

ScopedExpectation & mimicpp::ScopedExpectation::operator= ( ScopedExpectation && )

default

Defaulted move-assignment-operator.

Here is the call graph for this function:

operator=() [2/2]

ScopedExpectation & mimicpp::ScopedExpectation::operator= ( ScopedExpectation const & )

delete

Deleted copy-assignment-operator.

Here is the call graph for this function:

Member Data Documentation

loc

util::SourceLocation mimicpp::ScopedExpectation::loc

Initial value:

= {})
            : ScopedExpectation{std::forward<T>(object).finalize(std::move(loc))}
        {
        }
 
        
        ScopedExpectation(ScopedExpectation const&) = delete

---

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

• mimic++/Expectation.hpp