shared_model::validation::ValidationErrorCreator Class Reference

Helper class for ValidationError creation. More...

#include "validation_error_helpers.hpp"

Collaboration diagram for shared_model::validation::ValidationErrorCreator:

Public Member Functions
std::optional< ValidationError >	getValidationError (const ReasonName &name) &&
template<typename NameProvider >
std::optional< ValidationError >	getValidationErrorWithGeneratedName (NameProvider &&name_provider) &&
ValidationErrorCreator &	addReason (ReasonType reason)
	Add a reason to error. More...
ValidationErrorCreator &	addChildError (ValidationError error)
	Add a child error. More...
ValidationErrorCreator &	operator|= (std::optional< ReasonType > optional_reason)
	Add a reason, if any. More...
ValidationErrorCreator &	operator|= (std::optional< ValidationError > optional_error)
	Add a child error, if any. More...

Detailed Description

Helper class for ValidationError creation.

Member Function Documentation

addChildError()

ValidationErrorCreator & ValidationErrorCreator::addChildError

(

ValidationError

error

)

Add a child error.

Here is the caller graph for this function:

addReason()

ValidationErrorCreator & ValidationErrorCreator::addReason

(

ReasonType

reason

)

Add a reason to error.

Here is the caller graph for this function:

getValidationError()

std::optional< ValidationError > ValidationErrorCreator::getValidationError

(

const ReasonName &

name

)

&&

Extract the error, if any.

Parameters

name	- the name of resulting error, if any.

Here is the caller graph for this function:

getValidationErrorWithGeneratedName()

template<typename NameProvider >

std::optional<ValidationError> shared_model::validation::ValidationErrorCreator::getValidationErrorWithGeneratedName ( NameProvider &&  name_provider ) &&

inline

Extract the error, if any.

Parameters

name_provider

- a callable providing the name of resulting error, if any.

Here is the call graph for this function:

Here is the caller graph for this function:

operator|=() [1/2]

ValidationErrorCreator & ValidationErrorCreator::operator|=

(

std::optional< ReasonType >

optional_reason

)

Add a reason, if any.

Here is the call graph for this function:

Here is the caller graph for this function:

operator|=() [2/2]

ValidationErrorCreator & ValidationErrorCreator::operator|=

(

std::optional< ValidationError >

optional_error

)

Add a child error, if any.

Here is the call graph for this function:

---

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

• shared_model/validators/validation_error_helpers.hpp
• shared_model/validators/validation_error_helpers.cpp