Result of validation with error message and resolution hint. More...

#include <validation.hpp>

Collaboration diagram for rux::validation::ValidationResult:

[legend]

Public Member Functions
	operator bool () const

Static Public Member Functions
static ValidationResult	ok ()
static ValidationResult	error (std::string msg, std::string hint, std::vector< std::string > missing={})

Public Attributes
bool	success
std::string	error_message
std::string	resolution_hint
std::vector< std::string >	missing_data

Detailed Description

Result of validation with error message and resolution hint.

Definition at line 13 of file validation.hpp.

Member Function Documentation

◆ error()

ValidationResult rux::validation::ValidationResult::error	(	std::string	msg,
		std::string	hint,
		std::vector< std::string >	missing = {} )

inlinestatic

Definition at line 23 of file validation.hpp.

◆ ok()

ValidationResult rux::validation::ValidationResult::ok ( )

inlinestatic

Definition at line 21 of file validation.hpp.

◆ operator bool()

rux::validation::ValidationResult::operator bool ( ) const

inlineexplicit

Definition at line 19 of file validation.hpp.

References success.

Member Data Documentation

◆ error_message

std::string rux::validation::ValidationResult::error_message

Definition at line 15 of file validation.hpp.

◆ missing_data

std::vector<std::string> rux::validation::ValidationResult::missing_data

Definition at line 17 of file validation.hpp.

◆ resolution_hint

std::string rux::validation::ValidationResult::resolution_hint

Definition at line 16 of file validation.hpp.

◆ success

bool rux::validation::ValidationResult::success

Definition at line 14 of file validation.hpp.

Referenced by operator bool().

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

apps/rux/include/validation.hpp

Public Member Functions

Static Public Member Functions

Public Attributes