cppfig 0.1.0
Modern C++20 compile-time type-safe configuration library
Loading...
Searching...
No Matches
cppfig::ValidationResult Struct Reference

Result of a validation operation. More...

#include <validator.h>

Collaboration diagram for cppfig::ValidationResult:
[legend]

Public Member Functions

 operator bool () const
 

Static Public Member Functions

static auto Ok () -> ValidationResult
 Creates a successful validation result.
 
static auto Error (std::string message) -> ValidationResult
 Creates a failed validation result with an error message.
 

Public Attributes

bool is_valid = true
 
std::string error_message
 

Detailed Description

Result of a validation operation.

Member Function Documentation

◆ Error()

static auto cppfig::ValidationResult::Error ( std::string  message) -> ValidationResult
inlinestatic

Creates a failed validation result with an error message.

◆ Ok()

static auto cppfig::ValidationResult::Ok ( ) -> ValidationResult
inlinestatic

Creates a successful validation result.

◆ operator bool()

cppfig::ValidationResult::operator bool ( ) const
inlineexplicit

Member Data Documentation

◆ error_message

std::string cppfig::ValidationResult::error_message

◆ is_valid

bool cppfig::ValidationResult::is_valid = true

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