CatapultServer  v0.5.0.1 (Elephant)
ValidationResult.h File Reference
Include dependency graph for ValidationResult.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 catapult
 
 catapult::validators
 

Macros

#define DEFINE_VALIDATION_RESULT(SEVERITY, FACILITY, DESCRIPTION, CODE, FLAGS)
 Defines a validation result given SEVERITY, FACILITY, DESCRIPTION, CODE and FLAGS. More...
 

Enumerations

enum  catapult::validators::ResultSeverity : uint8_t { catapult::validators::ResultSeverity::Success = 0, catapult::validators::ResultSeverity::Neutral = 1, catapult::validators::ResultSeverity::Failure = 2 }
 Possible result severities (only two bits are used). More...
 
enum  catapult::validators::ResultFlags : uint8_t { catapult::validators::ResultFlags::None, catapult::validators::ResultFlags::Verbose = 1 }
 Possible result flags (only six bits are used). More...
 
enum  catapult::validators::ValidationResult : uint32_t { catapult::validators::ValidationResult::Success = 0x00000000, catapult::validators::ValidationResult::Neutral = 0x40000000, catapult::validators::ValidationResult::Failure = 0x80000000 }
 Enumeration of all possible validation results. More...
 

Functions

constexpr ValidationResult catapult::validators::MakeValidationResult (ResultSeverity severity, FacilityCode facility, uint16_t code, ResultFlags flags)
 Makes a validation result given severity, facility, code and flags. More...
 
constexpr ResultSeverity catapult::validators::GetSeverity (ValidationResult result)
 Extracts the encoded result severity from result. More...
 
constexpr bool catapult::validators::IsSet (ValidationResult result, ResultFlags flags)
 Checks if result has all flags set. More...
 
constexpr bool catapult::validators::IsValidationResultSuccess (ValidationResult result)
 Returns a value indicating whether the validation result is a success. More...
 
constexpr bool catapult::validators::IsValidationResultFailure (ValidationResult result)
 Returns a value indicating whether the validation result is a failure. More...
 
constexpr utils::LogLevel catapult::validators::MapToLogLevel (ValidationResult result)
 Maps validation result to an appropriate logging level. More...
 
std::ostream & catapult::validators::operator<< (std::ostream &out, ValidationResult result)
 Insertion operator for outputting result to out. More...
 

Macro Definition Documentation

◆ DEFINE_VALIDATION_RESULT

#define DEFINE_VALIDATION_RESULT (   SEVERITY,
  FACILITY,
  DESCRIPTION,
  CODE,
  FLAGS 
)
Value:
constexpr auto SEVERITY##_##FACILITY##_##DESCRIPTION = validators::MakeValidationResult( \
(validators::ResultSeverity::SEVERITY), \
(validators::FacilityCode::FACILITY), \
CODE, \
(validators::ResultFlags::FLAGS))

Defines a validation result given SEVERITY, FACILITY, DESCRIPTION, CODE and FLAGS.

catapult::validators::MakeValidationResult
constexpr ValidationResult MakeValidationResult(ResultSeverity severity, FacilityCode facility, uint16_t code, ResultFlags flags)
Makes a validation result given severity, facility, code and flags.
Definition: ValidationResult.h:63